Automatically Generated Makedocs #105
Open
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
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 is an automated PR from the Simplify team
What does this Pull Request do?
This PR parses your Repository's /docs folder and generates a mkdocs.yaml file which allows for building project documentation. More information about mkdocs can be found here.
Why do you want to do this?
Our goal is to make things easier to find, make actions on your repos take less time to do, and provide insights into the things that you need to know in order to do your jobs effectively.
Software Catalog is the basis for Backstage (Simplify). By adding your catalog-info.yaml into your repo (in the pull request that likely took you here) you will be registered automatically in the catalog. This unlocks a lot of features in Backstage that you will be able to take advantage of, including:
If your Repository doesn't have a catalog-info.yaml yet
You can have one automatically generated on your repository through the following Register Existing Repository form. Registering through with form will create a Pull Request on your repository asking to merge the automatically generated catalog-info.yaml file. Please merge the Pull Request and you're all
set to be added to the Simplify Hub 2.0 ecosystem.
What do we need from you?
All you need to do is merge this PR and the mkdocs file will be merged!
If you want to take advantage of some of the other features of Backstage, you will require some additional config in your yaml file (but this is a one time thing!). Here are more instructions on how to do that.
We also recommend setting up a GitHub
CODEOWNERSfile (instructions here). This is used to to set ownership of your repo in our portal.If you have more questions reach out in #simplify-hub and we'll be happy to help you out.
Happy coding!
-- The Simplify Team 馃殌