-
Notifications
You must be signed in to change notification settings - Fork 75
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: translate remaining .md files to .rst #2083
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.
Thanks for doing this!
My comments are a combination of specific requests and general observations, some of which may be better for a separate task.
|
||
See also: `How to write unit tests for a charm <https://juju.is/docs/sdk/write-a-unit-test-for-a-charm>`_ | ||
|
||
The ``tests/unit/test_charm.py`` file is the companion to |
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.
Same here - not all profiles generate this file. I think specifically the 12-factor ones don't.
docs/tutorial/write-your-first-kubernetes-charm-for-a-django-app.rst
Outdated
Show resolved
Hide resolved
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.
We'll need to:
- Fix all the indentation for the YAML code blocks; it needs to be based on two spaces or it won't render correctly.
- Fix outstanding lint errors.
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.
LGTM - the rest of the discussion is out of scope for me.
This is a partial for #2090, containing only what is currently in rST on main. Once #2083 is merged we can do the rest. I've also made a few tweaks to formatting related to those links --------- Co-authored-by: Michael DuBelko <[email protected]>
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.
Thanks for the very quick and excellent work, @jahn-junior!
I picked up a few small code-related blips that only fresh eyes would notice. Once those and the GitHub link question are resolved we should be able to merge.
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.
Thanks for accommodating everyone's suggestions, @jahn-junior!
I believe this is in a good state and is reasonably in step with prevailing patterns.
Unless there are major reservations about how this completes the original scope (MD to rST) or code functionality, I'd like to see this merged, and tackle further improvements as new tasks.
Translated remaining Markdown files from #2010 to reStructuredText.
The contents of each page remain largely unchanged, with the main exceptions being:
juju status
in tutorials was changed from a bash code directive to a terminal directive.