Skip to content

Commit

Permalink
Merge pull request #4021 from werf/doc-change-path
Browse files Browse the repository at this point in the history
docs: move documentation up to the one level
  • Loading branch information
alexey-igrychev committed Dec 13, 2021
2 parents 2cd0c04 + f01a3ed commit bf7a874
Show file tree
Hide file tree
Showing 530 changed files with 35 additions and 145 deletions.
13 changes: 6 additions & 7 deletions .github/workflows/docs_tests.yml
Expand Up @@ -48,31 +48,30 @@ jobs:
- name: Prepare
run: |
cd docs
mkdir -m 777 documentation/.jekyll-cache documentation/_site
cd documentation
mkdir -m 777 .jekyll-cache _site
gem update bundler
bundle install
- name: Build (ru)
if: matrix.lang == 'ru'
run: |
cd docs/documentation
cd docs
bundle exec jekyll build -d _site --config _config.yml,_config_ru.yml
- name: Build (en)
if: matrix.lang == 'en'
run: |
cd docs/documentation
cd docs
bundle exec jekyll build -d _site --config _config.yml
- name: Check links
run: |
cd docs/documentation
cd docs
bundle exec htmlproofer \
--allow-hash-href \
--empty-alt-ignore \
--check_html \
--url_ignore "/localhost/,/example.com/,/atseashop.com/,/https\:\/\/t.me/,/.slack.com/,/habr.com/,/cncf.io/,/\/guides/,/\/introduction\.html/,/\/installation\.html/,/werf_yaml.html#configuring-cleanup-policies/" \
--url_ignore "/localhost/,/example.com/,/atseashop.com/,/https\:\/\/t.me/,/.slack.com/,/habr.com/,/cncf.io/,/\/guides/,/\/introduction\.html/,/\/installation\.html/,/werf_yaml.html#configuring-cleanup-policies/,/css\/configuration-table.css/" \
--url_swap "documentation/v[0-9]+[^/]+/:documentation/" \
--http-status-ignore 0 \
--http-status-ignore "0,429" \
_site
4 changes: 2 additions & 2 deletions .github/workflows/website_converge_tag.yml
Expand Up @@ -34,7 +34,7 @@ jobs:
env:
WERF_RELEASE: "werfio-${{ env.Version }}-production"
WERF_NAMESPACE: "werfio-production"
WERF_DIR: "docs/documentation"
WERF_DIR: "docs"
WERF_LOG_VERBOSE: "on"
WERF_KUBE_CONTEXT: prod
WERF_SET_GITHUB_REF: "global.github_ref=${{ github.ref }}"
Expand All @@ -61,7 +61,7 @@ jobs:
env:
WERF_RELEASE: "werfio-${{ env.Version }}-test"
WERF_NAMESPACE: "werfio-test"
WERF_DIR: "docs/documentation"
WERF_DIR: "docs"
WERF_LOG_VERBOSE: "on"
WERF_KUBE_CONTEXT: dev
WERF_SET_GITHUB_REF: "global.github_ref=${{ github.ref }}"
2 changes: 1 addition & 1 deletion .github/workflows/website_converge_test.yml
Expand Up @@ -32,7 +32,7 @@ jobs:
env:
WERF_RELEASE: "werfio-documentation-test"
WERF_NAMESPACE: "werfio-test"
WERF_DIR: "docs/documentation"
WERF_DIR: "docs"
WERF_LOG_VERBOSE: "on"
WERF_KUBE_CONTEXT: dev
WERF_SET_GITHUB_REF: "global.github_ref=v1.2.3-dev"
6 changes: 3 additions & 3 deletions cmd/werf/docs/main.go
Expand Up @@ -27,9 +27,9 @@ func NewCmd(cmdGroups *templates.CommandGroups) *cobra.Command {

workingDir := common.GetWorkingDir(&commonCmdData)

partialsDir := filepath.Join(workingDir, "docs/documentation/_includes/reference/cli")
pagesDir := filepath.Join(workingDir, "docs/documentation/pages_en/reference/cli")
sidebarPath := filepath.Join(workingDir, "docs/documentation/_data/sidebars/_cli.yml")
partialsDir := filepath.Join(workingDir, "docs/_includes/reference/cli")
pagesDir := filepath.Join(workingDir, "docs/pages_en/reference/cli")
sidebarPath := filepath.Join(workingDir, "docs/_data/sidebars/_cli.yml")

for _, path := range []string{partialsDir, pagesDir} {
if err := createEmptyFolder(path); err != nil {
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Expand Up @@ -14,8 +14,8 @@
let version = encodeURIComponent(getDocVersionFromPage());
if (version.length > 0) {
let needCheckURL = false;
let pageURL = 'https://github.com{{ site.github_repo_path }}/blob/' + version + '/docs/documentation/{{ page.path }}';
let checkURL = 'https://api.github.com/repos{{ site.github_repo_path }}/contents/docs/documentation/{{ page.path }}?ref=' + version;
let pageURL = 'https://github.com{{ site.github_repo_path }}/blob/' + version + '/docs/{{ page.path }}';
let checkURL = 'https://api.github.com/repos{{ site.github_repo_path }}/contents/docs/{{ page.path }}?ref=' + version;
let $link = $('#editme_link');
if (needCheckURL) {
checkURLExist(checkURL, function (success) {
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
87 changes: 0 additions & 87 deletions docs/documentation/_config.yml

This file was deleted.

22 changes: 0 additions & 22 deletions docs/documentation/_config_ru.yml

This file was deleted.

File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit bf7a874

Please sign in to comment.