-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
docs: rename plugins index file and add linkTitle #5403
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5403 +/- ##
=======================================
Coverage 59.73% 59.73%
=======================================
Files 345 345
Lines 23394 23394
=======================================
Hits 13974 13974
Misses 8450 8450
Partials 970 970 |
We publish this page on docs.docker.com, and hugo expects index pages for sections to be named _index.md. We currently rename the page when we mount it to the docs repo but might as well change the filename in the source. Also adds a linkTitle to the page, which is a shorter title that will be used in the sidebar navigation and breadcrumbs. Signed-off-by: David Karlsson <[email protected]>
Signed-off-by: David Karlsson <[email protected]>
206f2b2
to
ed08874
Compare
@@ -13,14 +15,12 @@ keywords: "docker, documentation, about, technology, deprecate" | |||
will be rejected. | |||
--> | |||
|
|||
# Deprecated Engine Features |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These always surprise me (i.e.; why it can't automatically / organically pick the first H1 on the page).
Well, I guess it is what it is 🤷♂️
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
overall LGTM - left some suggestions / comments for consideration
ed08874
to
34fa116
Compare
Signed-off-by: David Karlsson <[email protected]>
34fa116
to
0fcaffb
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
We publish the engine plugin pages on docs.docker.com, and hugo expects index pages
for sections to be named _index.md.
Also adds a linkTitle to the plugin overview page, which is a shorter title that will be
used in the sidebar navigation and breadcrumbs, and a front matter title to the deprecated.md page.
also did a couple more fixes because the linter was angry
Signed-off-by: David Karlsson [email protected]
- What I did
- How I did it
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)