Skip to content

Commit

Permalink
docs: migrate to docusaurus implementation (#595)
Browse files Browse the repository at this point in the history
  • Loading branch information
Topener authored Nov 7, 2023
1 parent 27cf4dd commit 89ee3af
Show file tree
Hide file tree
Showing 16 changed files with 372 additions and 331 deletions.
6 changes: 3 additions & 3 deletions .github/semantic.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
titleOnly: true
titleOnly: false
commitsOnly: false
titleAndCommits: false
allowMergeCommits: false
titleAndCommits: true
allowMergeCommits: true
38 changes: 38 additions & 0 deletions .github/workflows/dhis2-verify-commits.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: 'dhis2: verify (commits)'

on:
pull_request:
types: ['opened', 'edited', 'reopened', 'synchronize']

jobs:
lint-pr-title:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
node-version: 16
cache: 'yarn'
- run: yarn install --frozen-lockfile
- id: commitlint
run: echo ::set-output name=config_path::$(node -e "process.stdout.write(require('@dhis2/cli-style').config.commitlint)")
- uses: JulienKode/[email protected]
with:
configuration-path: ${{ steps.commitlint.outputs.config_path }}

lint-commits:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- uses: actions/setup-node@v3
with:
node-version: 16
cache: 'yarn'
- run: yarn install --frozen-lockfile
- id: commitlint
run: echo ::set-output name=config_path::$(node -e "process.stdout.write(require('@dhis2/cli-style').config.commitlint)")
- uses: wagoid/commitlint-github-action@v5
with:
configFile: ${{ steps.commitlint.outputs.config_path }}
206 changes: 71 additions & 135 deletions CHANGELOG.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ See the [documentation site](https://cli.dhis2.nu) for end-user installation and

## Conventions

The `d2` command-line tool is structured as a collection of namespaces, each of which may include sub-namespaces and sub-commands. This heirarchy should follow one simple rule:
The `d2` command-line tool is structured as a collection of namespaces, each of which may include sub-namespaces and sub-commands. This hierarchy should follow one simple rule:

**namespaces are nouns, commands are verbs**

Each subsequent namespace should narrow the context in which a command (an action) will be performed. For example:

- `d2 cluster restart` performs the action **restart** in the **d2 cluster** namespace
- `d2 cluster restart` performs the action `restart` in the `d2 cluster` namespace
- `d2 style js apply` performs the **apply** action in the **js** sub-namespace of the **d2 style** namespace

Anything following the action verb is either a positional argument or a flag (if preceded by `-` or `--`), i.e.:
Expand Down
5 changes: 2 additions & 3 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
- [**Getting Started**](getting-started)
- **Commands**
- - [`d2`](commands/d2)
- - `d2 app`
- - - [`d2 app scripts`↗️](https://platform.dhis2.nu/#/scripts ':ignore')
- - [`d2 cluster`](commands/d2-cluster)
- - - [Use a stable version](recipes/stable)
- - - [Use a development version](recipes/development)
- - - [Use a custom Docker image](recipes/custom-image)
- - - [Use a custom `dhis.conf`](recipes/custom-dhis-config)
- - [`d2 style`↗️](https://cli-style.dhis2.nu ':ignore')
- - `d2 utils`
- - - [`d2 utils release`](commands/d2-utils-release)
- - - [`d2 utils cypress`↗️](https://cli-utils-cypress.dhis2.nu ':ignore')
- - - [`d2 utils docsite`↗️](https://cli-utils-docsite.dhis2.nu ':ignore')
- - [`d2 style`↗️](https://cli-style.dhis2.nu ':ignore')
- - [`d2 app scripts`↗️](https://platform.dhis2.nu/#/scripts ':ignore')
-  
- [Changelog](CHANGELOG)
Loading

0 comments on commit 89ee3af

Please sign in to comment.