Skip to content

Commit

Permalink
chore: Remove Docs from OSx Repo (#595)
Browse files Browse the repository at this point in the history
* fix: revert deleting step 3 in plugin publishing docs

* chore: move docs images (adapt paths), fix orthographic mistakes

* fix: remove images from OSx repo

* fix: redirect subgraph docs to proper Dev-Portal folder

* chore: remove docs from OSx

* ci: update workflows

* fix: exclude index.md file from being deleted in Dev-Portal

* Update .github/pull_request_template.md

Co-authored-by: Michael Heuer <[email protected]>

* chore: move framework-lifecycle folder outside of /developer-portal folder

---------

Co-authored-by: Michael Heuer <[email protected]>
  • Loading branch information
banasa44 and heueristik authored May 17, 2024
1 parent f607746 commit 42704e2
Show file tree
Hide file tree
Showing 73 changed files with 22 additions and 7,544 deletions.
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@ See the framework lifecycle in `packages/contracts/docs/framework-lifecycle` to
- [ ] I have updated the `DEPLOYMENT_CHECKLIST` file in the root folder.
- [ ] I have updated the `UPDATE_CHECKLIST` file in the root folder.
- [ ] I have updated the Subgraph and added a QA URL to the description of this PR.
- [ ] I have created a follow-up task to update the Developer Portal with the changes made in this PR.
11 changes: 7 additions & 4 deletions .github/workflows/documentation-update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,13 @@ jobs:
ref: staging
path: developer-portal
token: ${{ secrets.ARABOT_PAT }}
- name: Remove the docs/osx folder in the developer-portal
run: rm -rf $GITHUB_WORKSPACE/developer-portal/docs/osx
- name: Copy the docs/developer-portal folder to the developer-portal
run: cp -R packages/contracts/docs/developer-portal $GITHUB_WORKSPACE/developer-portal/docs/osx
- name: Remove the docs/osx/03-reference-guide folder in the developer-portal, excluding index.md
run: |
cd $GITHUB_WORKSPACE/developer-portal/docs/osx/03-reference-guide
shopt -s extglob
rm -rf !(index.md)
- name: Copy the docs/developer-portal/03-reference-guide folder to the developer-portal
run: cp -R packages/contracts/docs/developer-portal/03-reference-guide $GITHUB_WORKSPACE/developer-portal/docs/osx/03-reference-guide
- name: Get short commit hash
id: hash
run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/subgraph-documentation-update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ jobs:
path: developer-portal
token: ${{ secrets.ARABOT_PAT }}
- name: Remove the docs/subgraph folder in the developer-portal
run: rm -rf $GITHUB_WORKSPACE/developer-portal/docs/subgraph
run: rm -rf $GITHUB_WORKSPACE/developer-portal/versioned_docs/version-1.3.0/osx/subgraph
- name: Copy the docs/developer-portal folder to the developer-portal
run: cp -R packages/subgraph/docs/developer-portal $GITHUB_WORKSPACE/developer-portal/docs/subgraph
- name: Copy the generated schema-introspection.json to the developer-portal
run: cp -R packages/subgraph/docs/developer-portal $GITHUB_WORKSPACE/developer-portal/versioned_docs/version-1.3.0/osx/subgraph
- name: Copy the generated schema-introspection-partial.json to the developer-portal
run: cp -R packages/subgraph/docs/schema-introspection-partial.json $GITHUB_WORKSPACE/developer-portal/static/subgraph
- name: Get short commit hash
id: hash
Expand Down

This file was deleted.

This file was deleted.

Loading

0 comments on commit 42704e2

Please sign in to comment.