Skip to content

Commit

Permalink
Merge pull request #765 from newrelic/ru/schema-docs
Browse files Browse the repository at this point in the history
feat: generate schema docs from GraphQL
  • Loading branch information
rudouglas authored Feb 3, 2022
2 parents bb14305 + a3d3abb commit 496b9c2
Show file tree
Hide file tree
Showing 18 changed files with 1,878 additions and 2,088 deletions.
16 changes: 8 additions & 8 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ jobs:
console.log("Result:", result)
generate-schema-docs:
name: Generate schema documentation
name: Generate GraphQL schema documentation
needs: [generate-uuid]
runs-on: ubuntu-latest
steps:
Expand All @@ -108,17 +108,17 @@ jobs:
ref: 'main'
fetch-depth: 0

- name: Setup Python
uses: actions/setup-python@v2
- name: Setup Node.js
uses: actions/setup-node@v2
with:
python-version: '3.8'
node-version: 16

- name: Install dependencies
run: cd utils/schema-doc-generator && pip install -r requirements.txt
run: cd utils && yarn install

- name: Generate documentation
id: generate-docs
run: python utils/schema-doc-generator/script.py
- name: Generate schema docs for GraphQl
id: generate-schema
run: cd utils && yarn generate-schema-docs

- name: Commit changes
id: commit-changes
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Documentation

Each file in this directory (minus this readme) is generated from its equivalent schema found in [utils/schemas](../utils/schemas).
Each file in this directory (minus this readme) is generated from New Relic NerdGraph GraphQL schema.
61 changes: 0 additions & 61 deletions docs/alert_config.md

This file was deleted.

Loading

0 comments on commit 496b9c2

Please sign in to comment.