Adds Troubleshooting Guidance to Watchmaker Documentation-Set #3000
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Documentation says that adding an `:orphan:` tag to the journald.md file _should_ have suppressed the orphaned-file warning. Instead, needed to add an invisible TOC to the document that I want to reference the journald.md file as an embedded link rather than as a ToC element.
For proper presentation and navigation, the journald explanation needs to be declared an orphan. The RST `:orphan:` token is not honored by sphinx when used in embedded-RST in Markdown files.
* Remove toctree reference to journald article * Change link's extension to the RST-formatted journald article
It may also be desirable to add either a FAQ or troubleshooting entry, but this "note" will be the first step in the caveating processes around using `s3://` URIs.
This makes the snippet available for `literalinclude` usage in both the Linux- and Windows-specific guidance
lorengordon
reviewed
Jun 22, 2023
Co-authored-by: Loren Gordon <[email protected]>
Co-authored-by: Loren Gordon <[email protected]>
Co-authored-by: Loren Gordon <[email protected]>
Lulz... Co-authored-by: Loren Gordon <[email protected]>
You'd think I had typed this on my damned phone… Co-authored-by: Loren Gordon <[email protected]>
Co-authored-by: Loren Gordon <[email protected]>
I tend to be a fan of placing the example as close to the statement as possible, even if it splits a paragraph to do so. But, I'm not the _consumer_ of this product, so… Co-authored-by: Loren Gordon <[email protected]>
Co-authored-by: Loren Gordon <[email protected]>
This will allow easier reference and re-use, later
ferricoxide
changed the title
lorengordon
reviewed
Jul 19, 2023
docs/troubleshooting/Windows/c_watchmaker_logs_salt_call.debug.md
Outdated
Show resolved
Hide resolved
lorengordon
reviewed
Jul 19, 2023
Apply suggested fix-recommendations. Co-authored-by: Loren Gordon <[email protected]>
* Enumerate why we have subsections * Make links more obvious in AWS sub-section * Add footnote about EC2Launch vs EC2Launch v2
lorengordon
approved these changes
Jul 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #2995 for Linux-based execution.