2024-10-28 07:43:30 -04:00
|
|
|
|
# Guide Title (Only Visible in GitHub)
|
2023-12-15 11:10:41 -06:00
|
|
|
|
|
|
|
|
|
|
<div>
|
2024-10-16 23:54:12 +02:00
|
|
|
|
<a href="https://github.com/coder" style="text-decoration: none; color: inherit;">
|
2023-12-15 11:10:41 -06:00
|
|
|
|
<span style="vertical-align:middle;">Your Name</span>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
December 13, 2023
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
This is a guide on how to make Coder guides, it is not listed on our
|
2024-10-16 23:54:12 +02:00
|
|
|
|
[official tutorials page](../tutorials/index.md) in the docs. Intended for those
|
|
|
|
|
|
who don't frequently contribute documentation changes to the `coder/coder`
|
2024-07-10 21:31:37 +03:00
|
|
|
|
repository.
|
2023-12-15 11:10:41 -06:00
|
|
|
|
|
|
|
|
|
|
## Content
|
|
|
|
|
|
|
2026-06-01 08:47:29 -04:00
|
|
|
|
Defer to our [Contributing/Documentation](../about/contributing/documentation.md) page
|
2024-10-16 23:54:12 +02:00
|
|
|
|
for rules on technical writing.
|
2023-12-15 11:10:41 -06:00
|
|
|
|
|
|
|
|
|
|
### Adding Photos
|
|
|
|
|
|
|
|
|
|
|
|
Use relative imports in the markdown and store photos in
|
|
|
|
|
|
`docs/images/guides/<your_guide>/<image>.png`.
|
|
|
|
|
|
|
|
|
|
|
|
### Setting the author data
|
|
|
|
|
|
|
|
|
|
|
|
At the top of this example you will find a small html snippet that nicely
|
2024-10-28 07:43:30 -04:00
|
|
|
|
renders the author's name and photo, while linking to their GitHub profile.
|
2023-12-15 11:10:41 -06:00
|
|
|
|
Before submitting your guide in a PR, replace `your_github_handle`,
|
|
|
|
|
|
`your_github_profile_photo_url` and "Your Name". The entire `<img>` element can
|
|
|
|
|
|
be omitted.
|
|
|
|
|
|
|
|
|
|
|
|
## Setting up the routes
|
|
|
|
|
|
|
|
|
|
|
|
Once you've written your guide, you'll need to add its route to
|
|
|
|
|
|
`docs/manifest.json` under `Guides` > `"children"` at the bottom:
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
// Overrides the "# Guide Title" at the top of this file
|
|
|
|
|
|
"title": "Contributing to Guides",
|
|
|
|
|
|
"description": "How to add a guide",
|
|
|
|
|
|
"path": "./guides/my-guide-file.md"
|
|
|
|
|
|
},
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## Format before push
|
|
|
|
|
|
|
|
|
|
|
|
Before pushing your guide to github, run `make fmt` to format the files with
|
|
|
|
|
|
Prettier. Then, push your changes to a new branch and create a PR.
|