diff --git a/mkdocs.yml b/mkdocs.yml index d775ff3..8ab8179 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,14 +11,10 @@ nav: - articles/index.md - - Content Tags: tags.md - - Projects: - projects/index.md - #- Ansible Roles: projects/ansible-roles/index.md - - Gitlab CI: - Build: diff --git a/pages/projects/gitlab-ci/conventional_commits.md b/pages/projects/gitlab-ci/conventional_commits.md index 4447ee1..04c61da 100644 --- a/pages/projects/gitlab-ci/conventional_commits.md +++ b/pages/projects/gitlab-ci/conventional_commits.md @@ -119,7 +119,5 @@ In addition to the required variables above, the commitizen config file `.cz.yam ### Artifacts - -### License - -To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci) +!!! Note + Docs Still under development diff --git a/pages/projects/gitlab-ci/git_mirror.md b/pages/projects/gitlab-ci/git_mirror.md index 5501d89..c65eb0a 100644 --- a/pages/projects/gitlab-ci/git_mirror.md +++ b/pages/projects/gitlab-ci/git_mirror.md @@ -73,7 +73,5 @@ This will cause the job to only run on the `development` branch. - None - -## License - -To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci) +!!! Note + Docs Still under development diff --git a/pages/projects/gitlab-ci/gitlab_release.md b/pages/projects/gitlab-ci/gitlab_release.md index e7b2320..d28dcf8 100644 --- a/pages/projects/gitlab-ci/gitlab_release.md +++ b/pages/projects/gitlab-ci/gitlab_release.md @@ -140,8 +140,5 @@ This CI job's workflow is: - `Gitlab Release` > None - -### License - -To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci) - +!!! Note + Docs Still under development diff --git a/pages/projects/gitlab-ci/index.md b/pages/projects/gitlab-ci/index.md index 38cbf4a..588f169 100644 --- a/pages/projects/gitlab-ci/index.md +++ b/pages/projects/gitlab-ci/index.md @@ -5,3 +5,11 @@ date: 2021-08-11 template: project.html about: https://gitlab.com/nofusscomputing/projects/gitlab-ci --- + +!!! Note + Docs Still under development + +## Docs ToDo + +- Templates folder is for `gitlab-ci.yaml` that automagically create the jobs if included +- other sub folders are for `` which **DO NOT** automagically create jobs, but are pure definitions only. \ No newline at end of file diff --git a/pages/projects/gitlab-ci/markdown_lint.md b/pages/projects/gitlab-ci/markdown_lint.md index f136852..29c208f 100644 --- a/pages/projects/gitlab-ci/markdown_lint.md +++ b/pages/projects/gitlab-ci/markdown_lint.md @@ -59,7 +59,5 @@ Markdown Linting: - JUnit test report located at `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/*.junit.xml` - -## License - -To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci) +!!! Note + Docs Still under development diff --git a/pages/projects/gitlab-ci/mkdocs-build.md b/pages/projects/gitlab-ci/mkdocs-build.md index 3a13fb3..632758b 100644 --- a/pages/projects/gitlab-ci/mkdocs-build.md +++ b/pages/projects/gitlab-ci/mkdocs-build.md @@ -66,7 +66,5 @@ MKDocs build: - files in `"$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME"` - -## License - -To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci) +!!! Note + Docs Still under development diff --git a/pages/projects/gitlab-ci/python.md b/pages/projects/gitlab-ci/python.md index e7593df..05e2d04 100644 --- a/pages/projects/gitlab-ci/python.md +++ b/pages/projects/gitlab-ci/python.md @@ -105,7 +105,5 @@ PyLint: - `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.html` - html code quality report - -## License - -To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci) +!!! Note + Docs Still under development diff --git a/pages/projects/gitlab-ci/templates/ansible_roles.md b/pages/projects/gitlab-ci/templates/ansible_roles.md index 64f0832..0cfc2e8 100644 --- a/pages/projects/gitlab-ci/templates/ansible_roles.md +++ b/pages/projects/gitlab-ci/templates/ansible_roles.md @@ -62,8 +62,3 @@ Ansible Lint (python 3.6): - `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/$PYTHON_VERSION-ansible-lint.junit.xml` - JUnit Test report - `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME/$PYTHON_VERSION-ansible-lint.log` - Linter log - - -## License - -To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci) diff --git a/pages/projects/gitlab-ci/templates/docker_container.md b/pages/projects/gitlab-ci/templates/docker_container.md index 1d4593e..9c328ad 100644 --- a/pages/projects/gitlab-ci/templates/docker_container.md +++ b/pages/projects/gitlab-ci/templates/docker_container.md @@ -30,3 +30,6 @@ about: https://gitlab.com/nofusscomputing/projects/gitlab-ci # JOB_STOP_GITLAB_RELEASE: 'any value' ``` + +!!! Note + Docs Still under development diff --git a/pages/projects/gitlab-ci/templates/index.md b/pages/projects/gitlab-ci/templates/index.md index 14d6217..6d5d0ca 100644 --- a/pages/projects/gitlab-ci/templates/index.md +++ b/pages/projects/gitlab-ci/templates/index.md @@ -6,4 +6,13 @@ template: project.html about: https://gitlab.com/nofusscomputing/projects/gitlab-ci --- -As part of our Gitlab CI job definitions we also have gitlab-ci.yaml templates that are specifically designed for inclusion and will automagically add the required jobs. \ No newline at end of file +As part of our Gitlab CI job definitions we also have gitlab-ci.yaml templates that are specifically designed for inclusion and will automagically add the required jobs. + +## Docs ToDo + +- all templates are in the template folder. + +- explain `.gitlab-ci_common.yaml` is for inclusion by all, _suggested._ and will never create jobs, only specify defaults. is also included in all templates + +!!! Note + Docs Still under development diff --git a/pages/projects/gitlab-ci/templates/website.md b/pages/projects/gitlab-ci/templates/website.md index 8b73cd4..94ebb43 100644 --- a/pages/projects/gitlab-ci/templates/website.md +++ b/pages/projects/gitlab-ci/templates/website.md @@ -9,4 +9,7 @@ about: https://gitlab.com/nofusscomputing/projects/gitlab-ci This template creates the jobs applicable to publishing pages to a website. The website in question is a static site built by MKDocs. !!! Note - This template is specifically designed for deployment to https://nofusscomputing.com. However you _may_ be able to override the job definition to use it for your website. \ No newline at end of file + This template is specifically designed for deployment to https://nofusscomputing.com. However you _may_ be able to override the job definition to use it for your website. + +!!! Note + Docs Still under development diff --git a/pages/projects/gitlab-ci/yaml_lint.md b/pages/projects/gitlab-ci/yaml_lint.md index 6b87f63..63d1b51 100644 --- a/pages/projects/gitlab-ci/yaml_lint.md +++ b/pages/projects/gitlab-ci/yaml_lint.md @@ -65,6 +65,5 @@ Yaml Lint (python 3.6): - `$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME/$PYTHON_VERSION-yaml-lint.log` - Linter log -## License - -To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci) +!!! Note + Docs Still under development