Skip to content

Commit

Permalink
split the docs for better create cross page links
Browse files Browse the repository at this point in the history
  • Loading branch information
nolte committed Jan 23, 2024
1 parent 0275b3a commit 8c2a1b5
Show file tree
Hide file tree
Showing 9 changed files with 171 additions and 74 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ site

.github/styles/*
!.github/styles/.keep
.task
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,12 @@ Use [go-task/task](https://github.com/go-task/task) as pre-configured command se
task -l

task: Available tasks for this project:
* mkdocs: Start the Mkdocs, for development
* pre-commit: Start Precommit
* mkdocs:start: mkdocs serve docs
* pre-commit:install: install pre-commit into current project
* pre-commit:start: run pre-commit with all files

```
shared tasks from [nolte/taskfiles](https://github.com/nolte/taskfiles)

## Links

Expand Down
22 changes: 5 additions & 17 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,14 @@
version: '3'

vars:
PYTHON_VENVS_BASEDIR: ~/.venvs/

PYTHON_BIN: python3
VENVS: .venvs/
TASK_COLLECTION_BASE: https://raw.githubusercontent.com/nolte/taskfiles/fix/py-var-names/src

includes:
py-dev: ./taskfiles/py-venv-dev.yaml
mkdocs: "{{.TASK_COLLECTION_BASE}}/taskfile-include-mkdocs.yaml"
pre-commit: "{{.TASK_COLLECTION_BASE}}/taskfile-include-pre-commit.yaml"

tasks:
pre-commit:
desc: Start Precommit
deps: ["py-dev:venv-usage"]
default:
cmds:
- pre-commit run -a
- task -l
silent: true

mkdocs:
desc: Start the Mkdocs, for development
#deps: ["py-dev:venv-usage"]
cmds:
- task: py-dev:venv-usage
#- mkdocs serve -a localhost:8001
silent: false
33 changes: 33 additions & 0 deletions docs/features/labelling.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@

# Labelling

For Handle PR and Issue Labels use [boring-cyborg](https://probot.github.io/apps/boring-cyborg/) for setting labels by Existing roles, like changes at `./docs` always get the Label `documentations`.

## Usage

```yaml
{%
include "../../.github/boring-cyborg.yml"
%}
```

## Labelling rules

```yaml
{%
include "../../.github/commons-boring-cyborg.yml"
start="# <!--td-commons-settings-labels-start-->"
end="# <!--td-commons-settings-labels-end-->"
%}
```

## Existing labels

```yaml
{%
include "../../.github/commons-settings.yml"
start="# <!--td-commons-settings-labels-start-->"
end="# <!--td-commons-settings-labels-end-->"
%}
```
The labels will be pre-configured by use the [Settings](#project-settings) GitHub Application.
18 changes: 18 additions & 0 deletions docs/features/mkdocs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Publish Docs (mkdocs)

This Action is part of the template Project [nolte/cookiecutter-gh-project](https://github.com/nolte/cookiecutter-gh-project).

## Usage

**TBD**

## Central Configuration

The full Action configuration will be used from a central place.

```yaml
{%
include "../../.github/workflows/reusable-mkdocs.yaml"
%}
```
from `.github/workflows/reusable-mkdocs.yaml`.
66 changes: 66 additions & 0 deletions docs/features/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Release Process

using [release-drafter/release-drafter](https://github.com/release-drafter/release-drafter) for generate tagged release and generated release artefacts. This Action is part of the template Project [nolte/cookiecutter-gh-project](https://github.com/nolte/cookiecutter-gh-project).

## Usage


Two configurations must be created for use. The **GitHub Workflow**, and the **Probot** settings.

### Workflow

```yaml
---
name: Release Drafter

on:
push:
branches:
- develop

jobs:
update_release_draft:
uses: nolte/gh-plumbing/.github/workflows/reusable-release-drafter.yml@v1.1.8
secrets:
token: ${{ secrets.GITHUB_TOKEN }}

```
*(from `.github/workflows/release-drafter.yml`)*

### Probot

```sh
---
# These settings are synced to GitHub by https://probot.github.io/apps/release-drafter/

_extends: gh-plumbing:.github/commons-release-drafter.yml

```
*(from `.github/release-drafter.yml`)*

take a look to the release draft from this project:

[![.github/workflows/release-drafter.yml](https://github.com/nolte/gh-plumbing/actions/workflows/release-drafter.yml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/release-drafter.yml)

## Central Configuration

### Workflow

The full Action configuration will be used from a central place.

```yaml
{%
include "../../.github/workflows/reusable-release-drafter.yml"
%}
```
from `.github/workflows/reusable-release-drafter.yml`.


### Probot

```yaml
{%
include "../../.github/commons-release-drafter.yml"
%}
```
from `.github/commons-release-drafter.yml`.
33 changes: 33 additions & 0 deletions docs/features/settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Project settings

For Central Project Configuration use the [settings](https://probot.github.io/apps/settings/) GitHub App.

This Applications will be handle:

* Default Branch Configuration
* Project Description, topic etc.
* Label Colors


## Usage

### Probot

```yaml
_extends: gh-plumbing:.github/commons-settings.yml
repository:
name: cookiecutter-gh-project
description: Template for Create Github Workflows and Projects
homepage: https://nolte.github.io/cookiecutter-gh-project
topics: templating, cookiecutter, github
```
## Central Configuration¶
### Probot
```yaml
{%
include "../../.github/commons-settings.yml"
%}
```
10 changes: 10 additions & 0 deletions docs/features/static-tests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Static Tests (linting)

Generate a base set of workflows for execute Static Tests, like linting.

* [pre-commit/action](https://github.com/pre-commit/action)
* [zbeekman/EditorConfig-Action](https://github.com/zbeekman/EditorConfig-Action)

## Usage

## Central Configuration
55 changes: 0 additions & 55 deletions docs/probot.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,58 +22,3 @@ The Reusable configurations prefixed with ```.github/commons-*.yml```.
start="<!--td-probot-apps-start-->"
end="<!--td-probot-apps-end-->"
%}

#### Project settings

For Central Project Configuration use the [settings](https://probot.github.io/apps/settings/) GitHub App.

This Applications will be handle:

* Default Branch Configuration
* Project Description, topic etc.
* Label Colors


##### Usage

```yaml
_extends: gh-plumbing:.github/commons-settings.yml
repository:
name: cookiecutter-gh-project
description: Template for Create Github Workflows and Projects
homepage: https://nolte.github.io/cookiecutter-gh-project
topics: templating, cookiecutter, github
```

#### Labelling

For Handle PR and Issue Labels use [boring-cyborg](https://probot.github.io/apps/boring-cyborg/) for setting labels by Existing roles, like changes at `./docs` always get the Label `documentations`.

##### Usage

```yaml
{%
include "../.github/boring-cyborg.yml"
%}
```

##### Labelling rules

```yaml
{%
include "../.github/commons-boring-cyborg.yml"
start="# <!--td-commons-settings-labels-start-->"
end="# <!--td-commons-settings-labels-end-->"
%}
```

##### Existing labels

```yaml
{%
include "../.github/commons-settings.yml"
start="# <!--td-commons-settings-labels-start-->"
end="# <!--td-commons-settings-labels-end-->"
%}
```
The labels will be pre-configured by use the [Settings](#project-settings) GitHub Application.

0 comments on commit 8c2a1b5

Please sign in to comment.