Update sat_bootprep.md for docs hyperlink #141
Conversation
There was a problem hiding this comment.
Hi @ganeshs-hpe, can you please fill out the relevant sections of the pull request template? I can't really tell what you are trying to do with this change. Not all sections of the template my apply in this case. Please fill out the sections which do apply and remove the template text if the section does not apply.
Is there a Jira associated with this change?
I'm also wondering which version of the SAT product you are trying to update with this change. The last release of SAT as a separate product is SAT 2.6, which accompanies CSM 1.5. Starting with CSM 1.6, the SAT product will no longer be separate from CSM and will be fully included in CSM. As such, the documentation for SAT in CSM 1.6 can be found in docs-csm here: https://github.com/Cray-HPE/docs-csm/blob/release/1.6/operations/system_admin_toolkit/README.md
See my announcement here for more details about this change: https://rndwiki-pro.its.hpecorp.net/display/CASMSAT/2023-11-15+SAT+full+inclusion+in+CSM+v1.6.0
| @@ -18,7 +18,7 @@ install, upgrade, and deploy products on systems managed by CSM. Outside of IUF, | |||
| it is uncommon to use `sat bootprep`. For more information on this relationship, | |||
| see [SAT and IUF](sat_and_iuf.md). For more information on IUF, see the | |||
| [IUF section](https://cray-hpe.github.io/docs-csm/en-14/operations/iuf/iuf/) of | |||
| the [*Cray System Management Documentation*](https://cray-hpe.github.io/docs-csm/). | |||
| the [*Cray System Management Documentation*](https://github.com/Cray-HPE/docs-csm/blob/release/1.5/operations/configuration_management/Accessing_Sat_Bootprep_Files.md#accessing-sat-bootprep-files). | |||
There was a problem hiding this comment.
I'm not sure why you are changing this link. This link was intended to be a top-level link to the HTML version of CSM documentation, and from there, the reader should be able to find the section named "IUF section". Can you please explain what you are trying to achieve?
There was a problem hiding this comment.
I will also add some rationale for why we used these top-level links to the CSM documentation. As you'll notice in the link immediately preceding this one, if you want to link to a specific section of the CSM documentation, you have to include the CSM documentation version (e.g. "en-14"). As a result, it was hard for us to keep those links up-to-date, so we opted to link to the top level of the documentation without a version. When visiting this link, it will automatically default to the latest version of the CSM documentation.
With the move of docs-sat content into docs-csm (see my top-level comment), linking to other sections of docs-csm from the SAT documentation is now easier because we can use relative links to other markdown files within the same repository. So perhaps the problem you're trying to address is already fixed in the SAT documentation in docs-csm.
There was a problem hiding this comment.
Hello @haasken-hpe
Thanks for the detailed notes. It does cover the update I requested.
I agree that the above flow is more useful.
I verified that in CSM-1.6 branch, the update is already exists.
I will close this pull request.
Thanks.
|
Closing pull request due to my comment above. Thanks. |
Summary and Scope
Summarize what has changed. Explain why this PR is necessary. What is impacted? Is this a new feature, critical bug fix, etc?
Is this change backwards incompatible, backwards compatible, or a backwards compatible bugfix?
Issues and Related PRs
List and characterize relationship to Jira/Github issues and other pull requests. Be sure to list dependencies.
<insert branch name here><insert PR URL here>Testing
List the environments in which these changes were tested.
Tested on:
<development system>Test description:
How were the changes tested and success verified? If schema changes were part of this change, how were those handled in your upgrade/downgrade testing?
Risks and Mitigations
Are there known issues with these changes? Any other special considerations?
Pull Request Checklist