Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Combine dev container and building locally pages #785

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kprosise
Copy link
Contributor

Building locally using the dev container is the recommended way. Other cleanup performed on the page.

Added page redirect and updated links and references.

QA: checked rendered content, ran linkcheck and linter.

This commit addresses issue FFTK-3720, "combine pages for…"

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)

Overview

Building locally should be done via the dev container rather than setting up a local build host. As such the local build page and the dev container page have merged into a single page.

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

Building locally using the dev container is the recommended way.
Other cleanup performed on the page.

Added page redirect and updated links and references.

QA: checked rendered content, ran linkcheck and linter.

This commit addresses issue FFTK-3720, "combine pages for…"

Signed-off-by: Katrina Prosise <[email protected]>
@kprosise kprosise requested review from angolini, vanmaegima and a team January 23, 2025 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant