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

Add Schema Markdown to docs-api.talawa.io #2818

Open
palisadoes opened this issue Dec 31, 2024 · 2 comments
Open

Add Schema Markdown to docs-api.talawa.io #2818

palisadoes opened this issue Dec 31, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation feature request unapproved Unapproved for Pull Request

Comments

@palisadoes
Copy link
Contributor

This is for the develop-postgres branch

Is your feature request related to a problem? Please describe.

  1. In 2023 we made a successful manual attempt to convert the Talawa-API schema file to Markdown in the Talawa-Docs repo
  2. This file was:
    1. Obtained from the develop branch of Talawa-API
    2. Converted to JSON
    3. Manually copied to docs/github-actions/schema.json in Talawa-Docs
    4. The Talawa-Docs push GitHub action would generate markdown using push-schema-doc.yml based on the configuration in the docusaurus.config.js
      1. This GitHub Action file has now been archived as .github/workflows/archive/push-schema-doc.yml (inactive)
      2. The package that does this is https://github.com/graphql-markdown/graphql-markdown
  3. The resulting menu system can be found here at https://docs.talawa.io/docs/
    image
  4. The highlighted menu links all fall under this URL
    1. https://docs.talawa.io/docs/schema

There are several issues with this approach:

  1. The manual file copy needs to be automated
  2. We need to locate all Talawa-API markdown documentation in the new Docusaurus 'docs/' directory

Describe the solution you'd like

  1. As GitHub Actions, automatically generate the:
    1. JSON schema file and store it in a dedicated folder docs/github-actions in the Talawa-API repo tree
    2. Schema markdown for Docusaurus in the docs/docs/schema directory
    3. Docusaurus menu sidebar used in https://docs-api.talawa.io/ from the files in the docs/docs/schema directory
  2. Remove the Schema documents, files and menu from Talawa-Docs

This must be done without affecting any other functionality in either repo

Describe alternatives you've considered

  • N/A

Approach to be followed (optional)

  • See above

Additional context

You may want to coordinate with the persona assigned this issue and @Abhi-MS who is working on the docs.talawa.io website

Potential internship candidates

Please read this if you are planning to apply for a Palisadoes Foundation internship

@github-actions github-actions bot added documentation Improvements or additions to documentation unapproved Unapproved for Pull Request labels Dec 31, 2024
@govindup63
Copy link

can i get this issue assigned to me?

@Suyash878
Copy link
Contributor

I would like to work on this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature request unapproved Unapproved for Pull Request
Projects
None yet
Development

No branches or pull requests

3 participants