-
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: fill out remaining external link placeholders #1564
docs: fill out remaining external link placeholders #1564
Conversation
<!-- UPDATE LINKS: | ||
> Example implementations: [`mysql-k8s-operator`]() | ||
--> | ||
|
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.
Dropping this seems fine especially since we're going to be recommending jubilant for integration tests
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.
Yeah, I figure this entire page will be rewritten this cycle so there's no much point making any improvements.
Thanks @tonyandrewmeyer & @tmihoc. Approving with a couple of observations, which I can revisit (please add any thoughts that you have):
|
@dwilding I was just hacking the syntax from rST (and was in fact not aware of the possibility you mention). That said, I do think the brackets syntax suggests external link whereas the one I used aligns more with the |
I like your reasoning, @tmihoc. FWIW, in MyST .md files I prefer Anyway, again, no strong feelings. @tonyandrewmeyer I don't have any objection to merging this as-is. |
All the remaining "UPDATE LINKS" notes in the docs are replaced with actual links to the external Juju/Charmcraft docs.
Also changes the "product page" to be
juju.is
rather thanjuju.is/docs/sdk
as the latter is going away (juju.is
was recommended by @tmihoc).(These changes were previously in a commit in another PR but got lost when changes were forced - it seemed cleanest to break them out into a separate PR).