-
Notifications
You must be signed in to change notification settings - Fork 123
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
Conversation
There was a problem hiding this 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.
There was a problem hiding this 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
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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
@tonyandrewmeyer I've addressed all your comments, thanks! How does it look now? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, thanks!
This PR addresses a couple of issues:
Main changes: