Skip to content
This repository has been archived by the owner on Feb 9, 2024. It is now read-only.

GPT: Add Tech Docs (a documentation template) #92

Closed
christophe-f opened this issue Mar 29, 2023 · 1 comment · Fixed by #100 or #168
Closed

GPT: Add Tech Docs (a documentation template) #92

christophe-f opened this issue Mar 29, 2023 · 1 comment · Fixed by #100 or #168

Comments

@christophe-f
Copy link
Contributor

christophe-f commented Mar 29, 2023

The template will ask which component to link with and create a new repo.

EntityPicker:
        type: string
        ui:field: EntityPicker
        ui:options:
          catalogFilter:
            - kind: component

For example a component with the name node-website will have a new repo node-website-techdocs

The template skeleton will contain the mkdocs.yaml with the /docs folder contains a sample index.md
It will also create the GitHub Action pipeline. For example the one from Showcase: https://github.com/janus-idp/backstage-showcase/blob/main/.github/workflows/techdocs.yaml

No need to do Tekton pipeline yet.

Issues in Epic

@schultzp2020 schultzp2020 self-assigned this Apr 3, 2023
@serenamarie125 serenamarie125 changed the title Add a documentation template GPT: Add Tech Docs (a documentation template) Jun 22, 2023
@jasperchui jasperchui reopened this Jul 24, 2023
@jasperchui
Copy link

Reopen and convert to EPIC and capture doc and testing requirements.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.