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

Cleanup of docker reference manual #625

Merged
merged 1 commit into from
Nov 9, 2023

Conversation

kprosise
Copy link
Contributor

@kprosise kprosise commented Nov 8, 2023

Style guidelines applied.

Semantic newlines applied to follow best practices and to assist with editing.

Moved pages which serve more to guide than inform to a new section of the user guide, 'Containers and Docker'. Added the appropriate redirects, as well as updating landing/index pages as needed.

Ran linter, linkcheck, and viewed rendered html.

This commit addresses FFTK-2789
This commit applies to FFTK-988

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

A lot being updated here, including moving many pages to a new section of the User Guide. Happy to make further changes and consider all feedback!

Checklist

Optional. Add a 'x' to steps taken.
You can fill this out after opening the PR. "Did I..."

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • 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

There may very well be things I missed, as big updates like this can be a bit overwhelming.

@doanac
Copy link
Member

doanac commented Nov 8, 2023

@kprosise
Copy link
Contributor Author

kprosise commented Nov 8, 2023

I just realized I missed an issue for the restorable app page, will push again soon.

@doanac
Copy link
Member

doanac commented Nov 8, 2023

Copy link
Collaborator

@angolini angolini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems great 🚀 . I just added a few nits.
Otherwise, /lgtm

@doanac
Copy link
Member

doanac commented Nov 9, 2023

source/conf.py Outdated Show resolved Hide resolved
source/reference-manual/docker/docker-architecture.rst Outdated Show resolved Hide resolved
source/reference-manual/docker/private-registries.rst Outdated Show resolved Hide resolved
source/user-guide/containers-and-docker/containers.rst Outdated Show resolved Hide resolved
Style guidelines applied.

Semantic newlines applied to follow best practices and to assist with
editing.

Moved pages which serve more to guide than inform to a new section of
the user guide, 'Containers and Docker'. Added the appropriate
redirects, as well as updating landing/index pages as needed.

Ran linter, linkcheck, and viewed rendered html.

This commit addresses FFTK-2789
This commit applies to FFTK-988

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
@doanac
Copy link
Member

doanac commented Nov 9, 2023

@kprosise kprosise merged commit 3ec002f into foundriesio:main Nov 9, 2023
2 of 3 checks passed
@kprosise kprosise deleted the cleanup-docker branch November 9, 2023 17:05
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.

5 participants