Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve info about contributing to docs #1533

Merged
merged 12 commits into from
Jan 23, 2025

Conversation

dwilding
Copy link
Contributor

@dwilding dwilding commented Jan 20, 2025

This PR addresses a couple of issues:

Main changes:

  • In HACKING.md, split the Documentation section in two:
    • Contributing documentation - Added a high-level process for how to contribute, removed irrelevant info about Discourse docs and the release process, put the build instructions in a subsection (and updated them), kept the subsection about style, put the info about doc versions in a subsection.
    • Maintaining the documentation - The remaining subsections, unchanged. Primarily intended for the Charm Tech team.
  • In HACKING.md, updated the Contributing section to mention the importance of docstrings and link to "Contributing documentation".
  • On the docs homepage, changed the "Contribute docs" link so that it opens "Contributing documentation" in GitHub. Also adjusted the tagline of the link ("Get started on GitHub" instead of "The documentation sources on GitHub").

Copy link
Collaborator

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - just a couple of small suggestions.

Copy link
Contributor

@tonyandrewmeyer tonyandrewmeyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks! A couple of small suggestions and questions.

HACKING.md Outdated
Comment on lines 262 to 265
Use the `.. jujuadded:: x.y` directive to indicate that the feature is only
available when using version x.y (or higher) of Juju, `..jujuchanged:: x.y`
when the feature's behaviour _in ops_ changes, and `..jujuremoved:: x.y` when
the feature will be available in ops but not in that version (or later) of Juju.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These work in the ReST docstrings, but do they work in the Myst-Markdown general documentation? I think there we need to still use admonitions, right? Different markup to Discourse, but the same approach.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll double check this before merging - thanks for raising it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added an example for MyST Markdown in 50665df

@dwilding
Copy link
Contributor Author

@tonyandrewmeyer I've addressed all your comments, thanks! How does it look now?

Copy link
Contributor

@tonyandrewmeyer tonyandrewmeyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

@dwilding dwilding merged commit 8e47f83 into canonical:main Jan 23, 2025
32 checks passed
@dwilding dwilding deleted the hacking-docs branch January 23, 2025 01:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants