Cleanup porting guide #684
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Applied style guidelines where possible. Moved the introduction page to the index/ToC page, so as to provide an overview for the section up front. Checked rendered output in browser, focusing on visual elements. No issues spotted. This commit addresses FFTK-2995 Signed-off-by: Katrina Prosise <[email protected]>
|
Docs for 51c6995 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2594/docs/artifacts/html/index.html |
MrCry0
approved these changes
Feb 5, 2024
angolini
approved these changes
Feb 6, 2024
| Introduction | ||
| ------------ | ||
|
|
||
| This section provides guidelines and suggestions on how to add support for a machine not already supported by FoundriesFactory. |
There was a problem hiding this comment.
If we keep this structure, we need to find better names for the different levels. The Porting Guide is not a section. Would it be a document? A "part"? A chapter?
I mean, of course it's also a section, but I'm sure we can decide a better cluster name
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Applied style guidelines where possible. Moved the introduction page to the index/ToC page, so as to provide an overview for the section up front.
Checked rendered output in browser, focusing on visual elements. No issues spotted.
This commit addresses FFTK-2995
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
Overview
Checklist
make linkcheck.-s, --signoff).-S, --gpg-sign).Comments
@angolini other than merging the introduction with the top level/ToC page, I tried to keep the changes minimal, and most seemed to be related to breaking up sentences. Let me know if I should revert anything, or if you have any other recommended changes.