docs: Updates to landing pages and minor edits #26
Conversation
AshleyCliff
requested review from
NucciTheBoss
and removed request for
a team
There was a problem hiding this comment.
Overall, looks good.
I'd challenge removing the emojiis from the section headers given that it breaks the visual consistency with our other project READMEs. I don't think the emojiis are bad, and other community groups like the Rockcrafters use them in READMEs, but exclude them from the official rockcraft documentation.
A lot of projects on the awesome-readme collection use them as well. They can helps with engagement on GitHub, specifically. Here's one big project's README for example: https://github.com/gofiber/fiber#readme
Let me know your thoughts here.
There was a problem hiding this comment.
I don't think it's an issue for us to use emojiis here since READMEs are more meant for developers (us and the other Charmed HPC developers) than it is for potential customers. For example, the Rockcraft community uses emojiis sparingly in their community README: https://github.com/rockcrafters
I don't think it hurts to have them in the README, but they should largely be kept out of the actual documentation. I'm mostly hung up about their removal since it makes the docs repo visually inconsistent with our other repositories.
|
|
||
| 🚧 WIP 🚧 | ||
| Periodically, issues within the docs repository will be labeled as 'Good First Issues'. These issues are ideally the first place to get started helping with the Charmed HPC documentation. If there are currently no 'Good First Issues' or none that fit your interest, feel free to reach out on Matrix and ask if the team has any suggestions. Otherwise, small PRs for grammar and formatting are always a good place to start. |
There was a problem hiding this comment.
Just a couple suggested revisions here. Big thing is changing it from 'Good First Issues' to good first issue since that how our new issue labels are styled:
| Periodically, issues within the docs repository will be labeled as 'Good First Issues'. These issues are ideally the first place to get started helping with the Charmed HPC documentation. If there are currently no 'Good First Issues' or none that fit your interest, feel free to reach out on Matrix and ask if the team has any suggestions. Otherwise, small PRs for grammar and formatting are always a good place to start. | |
| Periodically, issues within the docs repository will be labeled as `good first issue`. These issues are ideally the first place to get started helping with Charmed HPC's documentation. If there are currently no issues labeled `good first issue`, or none of the issues fit your interest, feel free to reach out on [Matrix](https://matrix.to/#/#hpc:ubuntu.com) and ask if the team has any suggestions. Otherwise, small PRs for grammar and formatting are always a good place to start. |
|
|
||
| For more information on how to access or contribute to Charmed HPC's | ||
| documentation, check out the [Getting Started](#-getting-started) and | ||
| [Development](#️-development) sections below 👇 | ||
| [Development](#️-development) sections below. |
There was a problem hiding this comment.
I'll give you this one... the 👇 isn't necessary 🤣
|
|
||
| Use the following command to start the development server and see your | ||
| documentation changes render in real time: | ||
| To start the development server and render a local preview run: |
There was a problem hiding this comment.
[comment]: More succinct; I like it!
Updated the landing page descriptions for how-to and explanation, removed empty tutorial page for time being, updated homepage to reflect new content, and made some minor edits to the README and Contributing docs.