Skip to content

feat(wiki): regroup the navigation into seven sections and add the task-based home page - #595

Open
nilshoffmann wants to merge 9 commits into
devfrom
feat/website-styles
Open

nilshoffmann wants to merge 9 commits into
devfrom
feat/website-styles

Conversation

@nilshoffmann

@nilshoffmann nilshoffmann commented Oct 18, 2026 •

Copy link
Copy Markdown
Member

Regroups the wiki's navigation into seven sections and adds the task-based home page. The visual redesign that used to be part of this PR (theme, quick access bar, header, footer, logos, dark mode) has moved to the stacked draft PR #597, so the navigation and the home page can be reviewed and merged on their own.

Important

Builds on #592 and #591. Please review and merge those first. This branch starts from #592's commit (the task-based home page) and contains a cherry-picked copy of #591's commit (uv local preview). Until both are merged, their changes also show up in this diff. After they land, rebasing onto dev drops the duplicates.

What changes

Navigation

  • The navigation is regrouped from 12 top-level entries into 7 sections: Getting started, Portal, SimpleVM, OpenStack, Tutorials, Sites and FAQ. Site administrator pages sit under Sites.
  • No page URL changes; a test pins every URL.

Home page

  • The task-based home page from feat(wiki): task-based home page #592.
  • The home page ends with an "Improve this wiki" section: edit a page on GitHub, report a problem, or add a page with a pull request against dev.
  • The buttons at the top of the home page are gone.

Build and tests

  • uv for the local preview, from feat(build): manage local preview dependencies with uv #591.
  • uv run pytest builds the site and checks the rendered pages: the page URLs (taken from the sitemap), the navigation sections and the home page.
  • A new tests job in .github/workflows/main.yml runs it on pull requests.
  • The README explains how to run the checks.

How it was checked

  • 4 tests pass (uv run --locked pytest -q).

Notes for reviewers

Checklist

  • Please create your PR against the dev branch.
  • Please wait for all tests to finish.
  • All tests relevant to the changes introduced by this PR must pass. If a test fails due to an issue unrelated to this PR, it does not block this PR and should be handled separately.
  • When adding new documentation or a tutorial, make sure the corresponding Markdown file is linked in config.yml.
  • Once all the above points have been successfully completed, the PR can be merged.

🤖 Generated with Claude Code

nilshoffmann and others added 9 commits November 9, 2026 18:25
Replaces the section list on the home page with entry points for the
main reader groups: newcomers, Principal Investigators, OpenStack
users, sensitive data, workshops, Kubernetes, troubleshooting and site
administrators. Each card links straight to the relevant wiki pages
and to the matching pages on cloud.denbi.de.

Also adds a project type comparison, a "find your cloud site" section
(the site is shown as Facility on the portal project overview) and
clearer guidance on which support team to contact.

Enables md_in_html, which Material grid cards require.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
config_local.yml had drifted from config.yml: it lacked attr_list,
md_in_html, emoji, abbr, snippets and the macros, glightbox and git
revision plugins, and its navigation was outdated. Pages using grid
cards, icons or {{ extra.* }} macros did not render locally.

config_local.yml now inherits config.yml and only overrides docs_dir
and site_dir. To make that possible, the glossary snippet path in
config.yml is now relative to the config file instead of the absolute
container path; the container build output is unchanged.

pyproject.toml and uv.lock pin mkdocs, mkdocs-material,
pymdown-extensions and all plugins to the versions in the production
image (mkdocswebhook 3.9.7).

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Adds an "Improve this wiki" section to the home page: edit a page on
GitHub, report a problem as an issue, or add a page with a pull request
against dev.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The audience cards and the top navigation already lead to getting
started, the service status and help.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
On macOS, which ignores case, the page cloud_admin/elixir_OIDC/ was
written into the existing cloud_admin/Elixir_OIDC/ image folder, so the
URL baseline recorded the wrong case and the test failed on Linux CI.
The sitemap holds the URLs MkDocs actually publishes on every platform;
the baseline now has the production URL (cloud_admin/elixir_OIDC/).

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@nilshoffmann nilshoffmann changed the title feat(theme): align the wiki with the redesigned de.NBI Cloud website feat(wiki): regroup the navigation into seven sections and add the task-based home page Nov 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant