Add documentation command #63
Merged
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
This change set contains a new documentation command.
$ shuttle docs --project examples/moon-base
Documentation available at: https://github.com/lunarway/shuttle
It will open up documentation for the used shuttle plan. If a plan specifices a
top level "documentation" field, that is used. If not available the plan
reference is parsed and a URL is inferred.
The command will open the found URL respecting the BROWSER environment variable
and falling back to OS specific ways of "opening" URLs.
mahlunar
approved these changes
Mar 23, 2021
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.
This change set contains a new documentation command.
It will open up documentation for the used shuttle plan. If a plan specifies a
top level "documentation" field, that is used. If not available the plan
reference is parsed and a URL is inferred.
The command will open the found URL respecting the BROWSER environment variable
and falling back to OS specific ways of "opening" URLs.
Closes #49 as the issue was minded on easy access to the plan's documentation.
Also closes #7 as we cannot rely on docs only being available in a plans
README.md. As an example, in Lunar we document plans with MkDocs and publish
them to Backstage.io.