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.

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

Sidebar should be open for module details pages. #149

Open
viceice opened this issue Mar 22, 2022 · 6 comments
Open

Sidebar should be open for module details pages. #149

viceice opened this issue Mar 22, 2022 · 6 comments
Labels
bug Something isn't working

Comments

@viceice
Copy link
Member

viceice commented Mar 22, 2022

What browser are you using?

Not relevant

Describe the bug

if we open a module sub page, like npm manager, the sidebar is closed, it should be open instead.

Steps to reproduce
goto https://docs.renovatebot.com/modules/manager/npm/ and see closed sidebar

Additional context

@viceice viceice added the bug Something isn't working label Mar 22, 2022
@viceice
Copy link
Member Author

viceice commented Mar 22, 2022

Seeing same for platform

@HonkingGoose
Copy link
Collaborator

I think this is because those pages are not in the mkdocs.yml nav list.

@viceice
Copy link
Member Author

viceice commented Mar 22, 2022

I think this is because those pages are not in the mkdocs.yml nav list.

😕 So we need to add every single page? is there any other option to make this more generic?

@HonkingGoose
Copy link
Collaborator

Maybe we could autogenerate extra portions of the nav while we're building the site in the CI?

@HonkingGoose
Copy link
Collaborator

HonkingGoose commented Mar 23, 2022

I confirm the problem is with the pages not being in the nav in the mkdocs.yml file.
Check the mkdocs build output when run on current main branch:

Click me to see `mkdocs build` output
gitpod /workspace/renovatebot.github.io (main) $ mkdocs build
INFO     -  Cleaning site directory
INFO     -  Building documentation to directory: /workspace/renovatebot.github.io/site
INFO     -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
              - gitlab-bot-security.md
              - rust.md
              - security-and-permissions.md
              - self-hosted-experimental.md
              - setup-azure-devops.md
              - modules/manager/ansible/index.md
              - modules/manager/ansible-galaxy/index.md
              - modules/manager/argocd/index.md
              - modules/manager/azure-pipelines/index.md
              - modules/manager/batect/index.md
              - modules/manager/batect-wrapper/index.md
              - modules/manager/bazel/index.md
              - modules/manager/bitbucket-pipelines/index.md
              - modules/manager/buildkite/index.md
              - modules/manager/bundler/index.md
              - modules/manager/cake/index.md
              - modules/manager/cargo/index.md
              - modules/manager/cdnurl/index.md
              - modules/manager/circleci/index.md
              - modules/manager/cloudbuild/index.md
              - modules/manager/cocoapods/index.md
              - modules/manager/composer/index.md
              - modules/manager/conan/index.md
              - modules/manager/deps-edn/index.md
              - modules/manager/docker-compose/index.md
              - modules/manager/dockerfile/index.md
              - modules/manager/droneci/index.md
              - modules/manager/flux/index.md
              - modules/manager/fvm/index.md
              - modules/manager/git-submodules/index.md
              - modules/manager/github-actions/index.md
              - modules/manager/gitlabci/index.md
              - modules/manager/gitlabci-include/index.md
              - modules/manager/gomod/index.md
              - modules/manager/gradle/index.md
              - modules/manager/gradle-wrapper/index.md
              - modules/manager/helm-requirements/index.md
              - modules/manager/helm-values/index.md
              - modules/manager/helmfile/index.md
              - modules/manager/helmsman/index.md
              - modules/manager/helmv3/index.md
              - modules/manager/homebrew/index.md
              - modules/manager/html/index.md
              - modules/manager/jenkins/index.md
              - modules/manager/jsonnet-bundler/index.md
              - modules/manager/kubernetes/index.md
              - modules/manager/kustomize/index.md
              - modules/manager/leiningen/index.md
              - modules/manager/maven/index.md
              - modules/manager/meteor/index.md
              - modules/manager/mix/index.md
              - modules/manager/nodenv/index.md
              - modules/manager/npm/index.md
              - modules/manager/nuget/index.md
              - modules/manager/nvm/index.md
              - modules/manager/pip-compile/index.md
              - modules/manager/pip_requirements/index.md
              - modules/manager/pip_setup/index.md
              - modules/manager/pipenv/index.md
              - modules/manager/poetry/index.md
              - modules/manager/pre-commit/index.md
              - modules/manager/pub/index.md
              - modules/manager/pyenv/index.md
              - modules/manager/regex/index.md
              - modules/manager/ruby-version/index.md
              - modules/manager/sbt/index.md
              - modules/manager/setup-cfg/index.md
              - modules/manager/swift/index.md
              - modules/manager/terraform/index.md
              - modules/manager/terraform-version/index.md
              - modules/manager/terragrunt/index.md
              - modules/manager/terragrunt-version/index.md
              - modules/manager/travis/index.md
              - modules/platform/azure/index.md
              - modules/platform/bitbucket/index.md
              - modules/platform/bitbucket-server/index.md
              - modules/platform/gitea/index.md
              - modules/platform/github/index.md
              - modules/platform/gitlab/index.md
INFO     -  Documentation built in 3.70 seconds

Relevant quote from the mkdocs manual1:

Any pages not listed in your navigation configuration will still be rendered and included with the built site, however, they will not be linked from the global navigation and will not be included in the previous and next links. Such pages will be "hidden" unless linked to directly.

Footnotes

  1. https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation

@HonkingGoose
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants