Skip to content

Commit

Permalink
docs: create Docusaurus website (ngworker#143)
Browse files Browse the repository at this point in the history
## PR Checklist

Please check if your PR fulfills the following requirements:

- [x] The commit message follows our guidelines: CONTRIBUTING.md#commit
- [ ] Tests for the changes have been added (for bug fixes / features)
- [x] Docs have been added / updated (for bug fixes / features)

## PR Type

What kind of change does this PR introduce?

<!-- Please check the one that applies to this PR using "x". -->

```
[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[x] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:
```

## What is the current behavior?
No documentation website
<!-- Please describe the current behavior that you are modifying, or
link to a relevant issue. -->

Issue Number: N/A

## What is the new behavior?
A beautiful Docusaurus website.

## Does this PR introduce a breaking change?

```
[ ] Yes
[x] No
```

<!-- If this PR contains a breaking change, please describe the impact
and migration path for existing applications below. -->

## Other information
Done during The Frame Drops. Please donate at
https://donate.theframedrops.com

# To do
- [ ] Convert to TypeScript files

---------

Co-authored-by: Nacho Vazquez <[email protected]>
  • Loading branch information
LayZeeDK and NachoVazquez committed Jun 12, 2023
1 parent 7720da7 commit 32a5e17
Show file tree
Hide file tree
Showing 43 changed files with 5,939 additions and 1,347 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,39 @@ jobs:
# lower the number of agents to reduce spent compute time.
number-of-agents: 4

deploy-docs:
name: '[Merge] Deploy docs to GitHub Pages'
needs: dte_coordinator
if: github.event_name == 'push' && github.ref_name == 'main'
runs-on: ubuntu-latest
permissions:
contents: read
actions: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Check out the source code
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup
uses: ./.github/actions/setup
# Uses the cache generated in the distributed step
- name: Build docs
run: yarn nx build docs-lumberjack-docs-app
- name: Set up GitHub Pages
uses: actions/configure-pages@v2
- name: Upload docs to GitHub Pages
uses: actions/upload-pages-artifact@v1
with:
path: dist/packages/docs/lumberjack-docs-app/
- name: Deploy docs to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1

sonarcloud:
name: SonarCloud
needs: dte_coordinator
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,7 @@ Thumbs.db

# Nx
migrations.json

# Generated Docusaurus files
.docusaurus/
.cache-loader/
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
/coverage
/reports
/.angular/
.docusaurus/
Loading

0 comments on commit 32a5e17

Please sign in to comment.