Table of Contents updates #37
Conversation
AshleyCliff
requested review from
NucciTheBoss
and removed request for
a team
| @@ -3,22 +3,23 @@ | |||
|
|
|||
| The guides in this section provide detailed steps for key operations and common tasks for Charmed HPC. | |||
|
|
|||
| (howto-getstarted)= | |||
| ## Getting started | |||
| - {ref}`howto-initialize-cloud-environment` | |||
There was a problem hiding this comment.
This probably needs a description or context here, but I wasn't sure exactly what/how. Thoughts?
There was a problem hiding this comment.
How about this?
The guides in this section provide detailed steps for performing key operations and common tasks in Charmed HPC.
First steps
It is strongly recommend that you go through the {ref}
howto-initialize-cloud-environment <Initialize cloud environment>guide first before going through the {ref}Setup section <howto-setup>. This guide will show you how to set up access to the compute, storage, and networking resources your Charmed HPC cluster will need.
We could then add an admonition in the future that is like "first time using/deploying Charmed HPC? Check out these tutorials here" once we have some tutorials added.
There was a problem hiding this comment.
This looks good, I'll add it. And I agree adding the note pointing to tutorials eventually will help as well.
|
@AshleyCliff it looks like the
|
| @@ -3,22 +3,23 @@ | |||
|
|
|||
| The guides in this section provide detailed steps for key operations and common tasks for Charmed HPC. | |||
|
|
|||
| (howto-getstarted)= | |||
| ## Getting started | |||
| - {ref}`howto-initialize-cloud-environment` | |||
There was a problem hiding this comment.
How about this?
The guides in this section provide detailed steps for performing key operations and common tasks in Charmed HPC.
First steps
It is strongly recommend that you go through the {ref}
howto-initialize-cloud-environment <Initialize cloud environment>guide first before going through the {ref}Setup section <howto-setup>. This guide will show you how to set up access to the compute, storage, and networking resources your Charmed HPC cluster will need.
We could then add an admonition in the future that is like "first time using/deploying Charmed HPC? Check out these tutorials here" once we have some tutorials added.
|
Ready for a another look; I think I caught all the capitalization changes. |
Updates to Table of Contents, organization of how-to sections specifically, and fixing and updating of various references to pages across the docs.
(This is a new PR due to the prior having some problem not showing some updates.)