Skip to content
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: Improve TechDocs example documentation component #4237

Closed
OrkoHunter opened this issue Jan 25, 2021 · 2 comments · Fixed by #4983
Closed

Docs: Improve TechDocs example documentation component #4237

OrkoHunter opened this issue Jan 25, 2021 · 2 comments · Fixed by #4983
Labels
area:techdocs Related to the TechDocs Project Area documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Help/Contributions wanted from community members

Comments

@OrkoHunter
Copy link
Member

Feature Suggestion

Backstage mono-repo comes with an example component for TechDocs. It is located here
https://github.com/backstage/backstage/tree/master/plugins/techdocs-backend/examples/documented-component
and is loaded into the app from here

backstage/app-config.yaml

Lines 207 to 209 in c3ea694

# Example component for TechDocs
- type: file
target: ../../plugins/techdocs-backend/examples/documented-component/catalog-info.yaml

This component should be an exhaustive display of all the features that TechDocs/MkDocs provides.

Possible Implementation

  • Add few more sub pages.
  • Use one image and refer into markdown as relative path.
  • Load an external image using URL.
  • Look at the MkDocs extension that comes with mkdocs-techdocs-core and add a section in a page for each.

Context

Essentially we want this component for two use-cases

  1. Display most of the features
  2. Use as a place to test new implementations and making sure it doesn't break any of these plugins. (Will follow up with regression tests after the component is improved)
@OrkoHunter OrkoHunter added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Help/Contributions wanted from community members area:techdocs Related to the TechDocs Project Area labels Jan 25, 2021
@OrkoHunter
Copy link
Member Author

Assigned it to you! Ask here or drop by on Discord's #docs-like-code channel if you need any help.

@OrkoHunter
Copy link
Member Author

@Aiwwa I can't see your comment anymore hence, marking this issue up for grabs. Let us know if you're still working on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:techdocs Related to the TechDocs Project Area documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Help/Contributions wanted from community members
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants