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

[DRAFT] docs: Script to generate json schema of all tags #1551

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hlomzik
Copy link
Collaborator

@hlomzik hlomzik commented Aug 31, 2023

It's a part of create-docs script as it uses the same data and can produce two artifacts in one pass.

Schema is saved into tags-schema.json

JSON schema is like this:

{
  <tag name>: {
    name: <tag name>,
    description: <description>,
    [attrs: {
      <attr name>: {
        name: <attr name>,
        description: <description>,
        type: <type name or pipe-separated list of possible values>,
        required: <boolean>,
        default: <default value>,
      },
      [...]
    }],
  },
  [...]
}

PR fulfills these requirements

  • Commit message(s) and PR title follows the format [fix|feat|ci|chore|doc]: TICKET-ID: Short description of change made ex. fix: DEV-XXXX: Removed inconsistent code usage causing intermittent errors
  • Tests for the changes have been added/updated (for bug fixes/features)
  • Docs have been added/updated (for bug fixes/features)
  • Best efforts were made to ensure docs/code are concise and coherent (checked for spelling/grammatical errors, commented out code, debug logs etc.)
  • Self-reviewed and ran all changes on a local instance (for bug fixes/features)

Change has impacts in these area(s)

(check all that apply)

  • Product design
  • Frontend

Describe the reason for change

(link to issue, supportive screenshots etc.)

What does this fix?

(if this is a bug fix)

What is the new behavior?

(if this is a breaking or feature change)

What is the current behavior?

(if this is a breaking or feature change)

What libraries were added/updated?

(list all with version changes)

Does this change affect performance?

(if so describe the impacts positive or negative)

Does this change affect security?

(if so describe the impacts positive or negative)

What alternative approaches were there?

(briefly list any if applicable)

What feature flags were used to cover this change?

(briefly list any if applicable)

Does this PR introduce a breaking change?

(check only one)

  • Yes, and covered entirely by feature flag(s)
  • Yes, and covered partially by feature flag(s)
  • No
  • Not sure (briefly explain the situation below)

What level of testing was included in the change?

(check all that apply)

  • e2e
  • integration
  • unit

Which logical domain(s) does this change affect?

(for bug fixes/features, be as precise as possible. ex. Authentication, Annotation History, Review Stream etc.)

It's a part of `create-docs` script as it uses the same data
and can produce two artifacts in one pass.

Schema is saved into `tags-schema.json`

JSON schema is like this:
```json
{
  <tag name>: {
    name: <tag name>,
    description: <description>,
    [attrs: {
      <attr name>: {
        name: <attr name>,
        description: <description>,
        type: <type name or pipe-separated list of possible values>,
        required: <boolean>,
        default: <default value>,
      },
      [...]
    }],
  },
  [...]
}
```
@hlomzik hlomzik changed the title [DRAFTdocs: Script to generate json schema of all tags [DRAFT] docs: Script to generate json schema of all tags Aug 31, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant