Feedback: new.docs.gitlab.com beta release
Help us test the new GitLab Docs website!
We've rebuilt the GitLab Docs website using Hugo, a fast, modern static site generator.
Please visit the new website at https://new.docs.gitlab.com and leave a comment on this issue if you notice any problems.
The new site should look and feel very similar to the current website.
Like the current site, the new Hugo site is built hourly, so if you'd like, you can use it as you'd usually use the Docs site.
🎗 How to give feedback
- Check existing feedback & known issues: Before submitting, check to see if your feedback is already captured in the known issues section or reported by someone else in this issue. If so, comment on the existing thread or leave an emoji reaction to show support.
- Start a new thread: If your feedback is not listed, start a new thread with a descriptive title. Include relevant details, screenshots, and steps to reproduce the issue in expandable sections.
- Be Specific: Provide as much detail as possible, including device/browser information, steps to reproduce, and expected vs. actual outcomes.
Things to look for
- Malformed content (e.g, unrendered markdown).
- Visual/layout bugs
- Examples: Overlapping content or page regions, content that looks significantly different than the current site, inconsistencies between supported web browsers.
- Issues with custom elements (tabs, alert boxes, anything else that is now a shortcode) that we've programmatically migrated to the new Hugo format.
- Broken links.
🤝 What you can expect from us
- We will read all of your feedback.
- We may not respond to all feedback directly.
- We will create issues for repeatable bugs and assign a priority based on severity.
⚠ Known issues and changes in behavior
Known issues
- Table in GitLab documentation does not do well ... (gitlab-org/gitlab-docs#952 - closed) • Sarah German
- Nesting an alert inside a list, inside tabs, ca... (#104 - closed) • Hiru Fernando
- Tabs nested 2+ levels deep in lists do not render (#87 - closed) • Hiru Fernando • Backlog
- Minor visual bugs for mobile view (#97 - closed) • Hiru Fernando
Intentional changes
- URL paths are slightly different than the existing site. We are no longer using the "ee" prefix for Docs from the
gitlabproject. - The main column now has a maximum width for better readability, and extra space on wide screens fills in on either side of the content (see gitlab-org/gitlab-docs#673 (comment 499822347)).
- Minor visual changes were made to the global navigation (left nav) and table of contents component (right nav).
- Code blocks have a new look to make it easier to see the Copy button.
- Some pages will contain Kramdown tags (e.g,
{::options parse_block_html=“true” /}) until we resolve #76 (closed)
Coming soon, but not done yet
- Accessibility review (#41 - closed) • Hiru Fernando
- Implement feature flags list page (#17 - closed) • Hiru Fernando
- Port over existing redirects: Redirect management (#29 - closed) • Sarah German
📖 Reference links
- Dev project: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo
- Implementation epic: GitLab Docs to Hugo (gitlab-org&11891 - closed) • Unassigned
- Pre-implementation research: gitlab-org/technical-writing#849
Edited by Sarah German