Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Snippets and mkdocs adjustments #217

Merged
merged 12 commits into from
Aug 28, 2023
Merged

Snippets and mkdocs adjustments #217

merged 12 commits into from
Aug 28, 2023

Conversation

nemchik
Copy link
Member

@nemchik nemchik commented Aug 2, 2023 •
edited
Loading

Most of the mkdocs adjustments are spacing and general markdown fixes that won't affect anything else. mkdocs likes 4 space indentation for lists, so that's been included.

Example changes https://gist.github.com/nemchik/794c49535a203b77a4daeb6bffe04629/revisions

Ref: linuxserver/docker-documentation@master...Roxedus:docker-documentation:mkdocs

@nemchik
Adjustments for mkdocs
14aba91 
Consistency between documentation, lite, and readme

Signed-off-by: Eric Nemchik <eric@nemchik.com>
@nemchik nemchik marked this pull request as ready for review August 2, 2023 21:38
@LinuxServer-CI
Copy link
Contributor

I am a bot, here are the test results for this PR:
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-14aba910cf5789cbb27a1b3bd81ca43c984cbf81-pr-217/index.html
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-14aba910cf5789cbb27a1b3bd81ca43c984cbf81-pr-217/shellcheck-result.xml

Tag Passed
amd64-c8a52ae0-pkg-c8a52ae0-dev-14aba910cf5789cbb27a1b3bd81ca43c984cbf81-pr-217 ✅
arm64v8-c8a52ae0-pkg-c8a52ae0-dev-14aba910cf5789cbb27a1b3bd81ca43c984cbf81-pr-217 ✅

@nemchik
Add missing newline
5b3637f 
Signed-off-by: Eric Nemchik <eric@nemchik.com>
@LinuxServer-CI
Copy link
Contributor

I am a bot, here are the test results for this PR:
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-5b3637fcfa7404504141b349a1efc06a2e706d79-pr-217/index.html
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-5b3637fcfa7404504141b349a1efc06a2e706d79-pr-217/shellcheck-result.xml

Tag Passed
amd64-c8a52ae0-pkg-c8a52ae0-dev-5b3637fcfa7404504141b349a1efc06a2e706d79-pr-217 ✅
arm64v8-c8a52ae0-pkg-c8a52ae0-dev-5b3637fcfa7404504141b349a1efc06a2e706d79-pr-217 ✅

@nemchik
Copyable commands and empty line adjustments
10a2dd6 
Signed-off-by: Eric Nemchik <eric@nemchik.com>
@LinuxServer-CI
Copy link
Contributor

I am a bot, here are the test results for this PR:
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-10a2dd69683a70c115f54a9820bc17c791d6fc0e-pr-217/index.html
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-10a2dd69683a70c115f54a9820bc17c791d6fc0e-pr-217/shellcheck-result.xml

Tag Passed
amd64-c8a52ae0-pkg-c8a52ae0-dev-10a2dd69683a70c115f54a9820bc17c791d6fc0e-pr-217 ✅
arm64v8-c8a52ae0-pkg-c8a52ae0-dev-10a2dd69683a70c115f54a9820bc17c791d6fc0e-pr-217 ✅

@nemchik
Rip and snip
148a593 
Signed-off-by: Eric Nemchik <eric@nemchik.com>
@nemchik nemchik changed the title Adjustments for mkdocs Snippets and mkdocs adjustments Aug 3, 2023
@nemchik nemchik requested a review from a team August 3, 2023 01:46
@LinuxServer-CI
Copy link
Contributor

I am a bot, here are the test results for this PR:
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-148a593139358e3bb31472efc64e69ede85340a6-pr-217/index.html
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-148a593139358e3bb31472efc64e69ede85340a6-pr-217/shellcheck-result.xml

Tag Passed
amd64-c8a52ae0-pkg-c8a52ae0-dev-148a593139358e3bb31472efc64e69ede85340a6-pr-217 ✅
arm64v8-c8a52ae0-pkg-c8a52ae0-dev-148a593139358e3bb31472efc64e69ede85340a6-pr-217 ✅

@Roxedus
Copy link
Member

Roxedus commented Aug 4, 2023

Its worth making a branch pre-mkdocs restructure in the docs repo, and use the opportunity to upgrade the git connection in gitbook to look at that branch, just to not break the gitbook page.

Roxedus
Roxedus requested changes Aug 4, 2023
View reviewed changes
Copy link
Member

@Roxedus Roxedus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also look into making some of the exsiting snippets to admonitions on docs

roles/generate-jenkins/templates/VERSION_TAGS.j2 Outdated Show resolved Hide resolved
roles/generate-jenkins/templates/README_SNIPPETS/ENV_VAR_FILES.j2 Outdated Show resolved Hide resolved
roles/generate-jenkins/templates/README_SNIPPETS/UPDATING_INFO.j2 Outdated Show resolved Hide resolved
roles/generate-jenkins/templates/README_SNIPPETS/UPDATING_INFO.j2 Outdated Show resolved Hide resolved
roles/generate-jenkins/templates/DOCUMENTATION.j2 Show resolved Hide resolved
@nemchik
Fix incorrect file location
566152e 
Signed-off-by: GitHub <noreply@github.com>
@nemchik
Adjust secret example
e7f3b7d 
Signed-off-by: GitHub <noreply@github.com>
@nemchik
admonitions
22f544c 
Signed-off-by: GitHub <noreply@github.com>
@nemchik
Copy link
Member Author

nemchik commented Aug 4, 2023

We should also look into making some of the exsiting snippets to admonitions on docs

I've started working on the specific ones you called out in the review comments, but I can look at more later. I have not yet run a test build with the admonition changes, and definitely want to before proceeding. Will try to do so over the weekend.

@LinuxServer-CI
Copy link
Contributor

I am a bot, here are the test results for this PR:
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-22f544cc406c43c6641ccdc4c32fa84a16ad7f30-pr-217/index.html
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-22f544cc406c43c6641ccdc4c32fa84a16ad7f30-pr-217/shellcheck-result.xml

Tag Passed
amd64-c8a52ae0-pkg-c8a52ae0-dev-22f544cc406c43c6641ccdc4c32fa84a16ad7f30-pr-217 ✅
arm64v8-c8a52ae0-pkg-c8a52ae0-dev-22f544cc406c43c6641ccdc4c32fa84a16ad7f30-pr-217 ✅

@nemchik
Copy link
Member Author

nemchik commented Aug 5, 2023

Updated https://gist.github.com/nemchik/794c49535a203b77a4daeb6bffe04629/revisions with a revision showing the admonition changes.

@LinuxServer-CI
Copy link
Contributor

I am a bot, here are the test results for this PR:
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-2e8ce0accd34e55b5f0efae9466b8bfdee2eb6eb-pr-217/index.html
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-2e8ce0accd34e55b5f0efae9466b8bfdee2eb6eb-pr-217/shellcheck-result.xml

Tag Passed
amd64-c8a52ae0-pkg-c8a52ae0-dev-2e8ce0accd34e55b5f0efae9466b8bfdee2eb6eb-pr-217 ✅
arm64v8-c8a52ae0-pkg-c8a52ae0-dev-2e8ce0accd34e55b5f0efae9466b8bfdee2eb6eb-pr-217 ✅

@LinuxServer-CI
Copy link
Contributor

I am a bot, here are the test results for this PR:
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-82526a802cd011649ac1c91d4f33d4980c8ffc43-pr-217/index.html
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-82526a802cd011649ac1c91d4f33d4980c8ffc43-pr-217/shellcheck-result.xml

Tag Passed
amd64-c8a52ae0-pkg-c8a52ae0-dev-82526a802cd011649ac1c91d4f33d4980c8ffc43-pr-217 ✅
arm64v8-c8a52ae0-pkg-c8a52ae0-dev-82526a802cd011649ac1c91d4f33d4980c8ffc43-pr-217 ✅

@gene1wood gene1wood mentioned this pull request Aug 17, 2023
Closed
1 task
@nemchik
Minor spelling update
a406464 
Signed-off-by: Eric Nemchik <eric@nemchik.com>
@LinuxServer-CI
Copy link
Contributor

I am a bot, here are the test results for this PR:
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-8b54772472e33efeb2107b35ef7a5804b419e2f9-pr-217/index.html
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-8b54772472e33efeb2107b35ef7a5804b419e2f9-pr-217/shellcheck-result.xml

Tag Passed
amd64-c8a52ae0-pkg-c8a52ae0-dev-8b54772472e33efeb2107b35ef7a5804b419e2f9-pr-217 ✅
arm64v8-c8a52ae0-pkg-c8a52ae0-dev-8b54772472e33efeb2107b35ef7a5804b419e2f9-pr-217 ✅

@nemchik
Fix md error
26ec94b 
Signed-off-by: Eric Nemchik <eric@nemchik.com>
@LinuxServer-CI
Copy link
Contributor

I am a bot, here are the test results for this PR:
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-ce688e0a276e5f705e06d077a9187179633f5e9e-pr-217/index.html
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-ce688e0a276e5f705e06d077a9187179633f5e9e-pr-217/shellcheck-result.xml

Tag Passed
amd64-c8a52ae0-pkg-c8a52ae0-dev-ce688e0a276e5f705e06d077a9187179633f5e9e-pr-217 ✅
arm64v8-c8a52ae0-pkg-c8a52ae0-dev-ce688e0a276e5f705e06d077a9187179633f5e9e-pr-217 ✅

@LinuxServer-CI
Copy link
Contributor

I am a bot, here are the test results for this PR:
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-254dde8ee4944636437906c4480b6bec195ce2fa-pr-217/index.html
https://ci-tests.linuxserver.io/lspipepr/jenkins-builder/c8a52ae0-pkg-c8a52ae0-dev-254dde8ee4944636437906c4480b6bec195ce2fa-pr-217/shellcheck-result.xml

Tag Passed
amd64-c8a52ae0-pkg-c8a52ae0-dev-254dde8ee4944636437906c4480b6bec195ce2fa-pr-217 ✅
arm64v8-c8a52ae0-pkg-c8a52ae0-dev-254dde8ee4944636437906c4480b6bec195ce2fa-pr-217 ✅

@nemchik nemchik merged commit a40152e into monthly Aug 28, 2023
2 checks passed
@nemchik nemchik deleted the monthly-mkdocs branch August 28, 2023 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Roxedus Roxedus Roxedus approved these changes

Assignees
No one assigned
Labels
None yet
Projects
Issue & PR Tracker
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nemchik @LinuxServer-CI @Roxedus