From 7c385b7552945699eb87ec3ec43169df0cb77297 Mon Sep 17 00:00:00 2001 From: Jon Date: Tue, 23 May 2023 09:03:30 +0930 Subject: [PATCH] refactor(docs): pages dir renamed to docs as the contents are docs, renamed to make obvious !26 --- {pages => docs}/CHANGELOG.md | 0 {pages => docs}/articles/index.md | 0 {pages => docs}/contact.md | 0 {pages => docs}/index.md | 0 {pages => docs}/operations/index.md | 0 {pages => docs}/projects/ansible-roles/index.md | 0 {pages => docs}/projects/gitlab-ci/conventional_commits.md | 0 {pages => docs}/projects/gitlab-ci/git_mirror.md | 0 {pages => docs}/projects/gitlab-ci/gitlab_release.md | 0 {pages => docs}/projects/gitlab-ci/index.md | 0 {pages => docs}/projects/gitlab-ci/markdown_lint.md | 0 {pages => docs}/projects/gitlab-ci/mkdocs-build.md | 0 {pages => docs}/projects/gitlab-ci/python.md | 0 .../projects/gitlab-ci/templates/ansible_roles.md | 0 .../projects/gitlab-ci/templates/docker_container.md | 0 {pages => docs}/projects/gitlab-ci/templates/index.md | 0 {pages => docs}/projects/gitlab-ci/templates/website.md | 0 {pages => docs}/projects/gitlab-ci/yaml_lint.md | 0 {pages => docs}/projects/index.md | 0 {pages => docs}/tags.md | 0 lint/markdown.gitlab-ci.yaml | 6 +++--- mkdocs.yml | 4 +++- template/website.gitlab-ci.yaml | 4 +++- 23 files changed, 9 insertions(+), 5 deletions(-) rename {pages => docs}/CHANGELOG.md (100%) rename {pages => docs}/articles/index.md (100%) rename {pages => docs}/contact.md (100%) rename {pages => docs}/index.md (100%) rename {pages => docs}/operations/index.md (100%) rename {pages => docs}/projects/ansible-roles/index.md (100%) rename {pages => docs}/projects/gitlab-ci/conventional_commits.md (100%) rename {pages => docs}/projects/gitlab-ci/git_mirror.md (100%) rename {pages => docs}/projects/gitlab-ci/gitlab_release.md (100%) rename {pages => docs}/projects/gitlab-ci/index.md (100%) rename {pages => docs}/projects/gitlab-ci/markdown_lint.md (100%) rename {pages => docs}/projects/gitlab-ci/mkdocs-build.md (100%) rename {pages => docs}/projects/gitlab-ci/python.md (100%) rename {pages => docs}/projects/gitlab-ci/templates/ansible_roles.md (100%) rename {pages => docs}/projects/gitlab-ci/templates/docker_container.md (100%) rename {pages => docs}/projects/gitlab-ci/templates/index.md (100%) rename {pages => docs}/projects/gitlab-ci/templates/website.md (100%) rename {pages => docs}/projects/gitlab-ci/yaml_lint.md (100%) rename {pages => docs}/projects/index.md (100%) rename {pages => docs}/tags.md (100%) diff --git a/pages/CHANGELOG.md b/docs/CHANGELOG.md similarity index 100% rename from pages/CHANGELOG.md rename to docs/CHANGELOG.md diff --git a/pages/articles/index.md b/docs/articles/index.md similarity index 100% rename from pages/articles/index.md rename to docs/articles/index.md diff --git a/pages/contact.md b/docs/contact.md similarity index 100% rename from pages/contact.md rename to docs/contact.md diff --git a/pages/index.md b/docs/index.md similarity index 100% rename from pages/index.md rename to docs/index.md diff --git a/pages/operations/index.md b/docs/operations/index.md similarity index 100% rename from pages/operations/index.md rename to docs/operations/index.md diff --git a/pages/projects/ansible-roles/index.md b/docs/projects/ansible-roles/index.md similarity index 100% rename from pages/projects/ansible-roles/index.md rename to docs/projects/ansible-roles/index.md diff --git a/pages/projects/gitlab-ci/conventional_commits.md b/docs/projects/gitlab-ci/conventional_commits.md similarity index 100% rename from pages/projects/gitlab-ci/conventional_commits.md rename to docs/projects/gitlab-ci/conventional_commits.md diff --git a/pages/projects/gitlab-ci/git_mirror.md b/docs/projects/gitlab-ci/git_mirror.md similarity index 100% rename from pages/projects/gitlab-ci/git_mirror.md rename to docs/projects/gitlab-ci/git_mirror.md diff --git a/pages/projects/gitlab-ci/gitlab_release.md b/docs/projects/gitlab-ci/gitlab_release.md similarity index 100% rename from pages/projects/gitlab-ci/gitlab_release.md rename to docs/projects/gitlab-ci/gitlab_release.md diff --git a/pages/projects/gitlab-ci/index.md b/docs/projects/gitlab-ci/index.md similarity index 100% rename from pages/projects/gitlab-ci/index.md rename to docs/projects/gitlab-ci/index.md diff --git a/pages/projects/gitlab-ci/markdown_lint.md b/docs/projects/gitlab-ci/markdown_lint.md similarity index 100% rename from pages/projects/gitlab-ci/markdown_lint.md rename to docs/projects/gitlab-ci/markdown_lint.md diff --git a/pages/projects/gitlab-ci/mkdocs-build.md b/docs/projects/gitlab-ci/mkdocs-build.md similarity index 100% rename from pages/projects/gitlab-ci/mkdocs-build.md rename to docs/projects/gitlab-ci/mkdocs-build.md diff --git a/pages/projects/gitlab-ci/python.md b/docs/projects/gitlab-ci/python.md similarity index 100% rename from pages/projects/gitlab-ci/python.md rename to docs/projects/gitlab-ci/python.md diff --git a/pages/projects/gitlab-ci/templates/ansible_roles.md b/docs/projects/gitlab-ci/templates/ansible_roles.md similarity index 100% rename from pages/projects/gitlab-ci/templates/ansible_roles.md rename to docs/projects/gitlab-ci/templates/ansible_roles.md diff --git a/pages/projects/gitlab-ci/templates/docker_container.md b/docs/projects/gitlab-ci/templates/docker_container.md similarity index 100% rename from pages/projects/gitlab-ci/templates/docker_container.md rename to docs/projects/gitlab-ci/templates/docker_container.md diff --git a/pages/projects/gitlab-ci/templates/index.md b/docs/projects/gitlab-ci/templates/index.md similarity index 100% rename from pages/projects/gitlab-ci/templates/index.md rename to docs/projects/gitlab-ci/templates/index.md diff --git a/pages/projects/gitlab-ci/templates/website.md b/docs/projects/gitlab-ci/templates/website.md similarity index 100% rename from pages/projects/gitlab-ci/templates/website.md rename to docs/projects/gitlab-ci/templates/website.md diff --git a/pages/projects/gitlab-ci/yaml_lint.md b/docs/projects/gitlab-ci/yaml_lint.md similarity index 100% rename from pages/projects/gitlab-ci/yaml_lint.md rename to docs/projects/gitlab-ci/yaml_lint.md diff --git a/pages/projects/index.md b/docs/projects/index.md similarity index 100% rename from pages/projects/index.md rename to docs/projects/index.md diff --git a/pages/tags.md b/docs/tags.md similarity index 100% rename from pages/tags.md rename to docs/tags.md diff --git a/lint/markdown.gitlab-ci.yaml b/lint/markdown.gitlab-ci.yaml index fafed23..cf89674 100644 --- a/lint/markdown.gitlab-ci.yaml +++ b/lint/markdown.gitlab-ci.yaml @@ -36,13 +36,13 @@ - when: never -.Lint_Markdown_Pages: +.Lint_Markdown_Docs: variables: - MDLINT_PATHS: "pages/*.md pages/**/*.md pages/**/**/*.md pages/**/**/**/*.md pages/**/**/**/**/**/*.md #CHANGELOG.md !gitlab-ci !website-template" + MDLINT_PATHS: "docs/*.md docs/**/*.md docs/**/**/*.md docs/**/**/**/*.md docs/**/**/**/**/**/*.md #CHANGELOG.md !gitlab-ci !website-template" MD_LINT_CONFIG_PATH: "$CI_PROJECT_DIR/website-template" extends: .Lint_Markdown rules: - if: '$CI_COMMIT_BRANCH' exists: - - "pages/index.md" + - "docs/index.md" - when: never \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 9d8d95f..51182ea 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,8 +1,10 @@ INHERIT: website-template/mkdocs.yml +docs_dir: 'docs' + repo_name: Gitlab-CI repo_url: https://gitlab.com/nofusscomputing/projects/gitlab-ci -edit_uri: '/-/ide/project/nofusscomputing/projects/gitlab-ci/edit/development/-/pages/' +edit_uri: '/-/ide/project/nofusscomputing/projects/gitlab-ci/edit/development/-/docs/' nav: - Home: index.md diff --git a/template/website.gitlab-ci.yaml b/template/website.gitlab-ci.yaml index 2087439..acc8648 100644 --- a/template/website.gitlab-ci.yaml +++ b/template/website.gitlab-ci.yaml @@ -8,10 +8,12 @@ include: Website.Lint: - extends: .Lint_Markdown_Pages + extends: .Lint_Markdown_Docs Website.Build: + variables: + MKDOCS_SOURCE_PATH: docs extends: .MKDocs_Build needs: [ 'Website.Lint' ]