docs: rename plugins index file and add linkTitle #5403
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
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 <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
dvdksn
force-pushed
the
docs-update-titles
branch
from
206f2b2
to
ed08874
Compare
thaJeztah
reviewed
Sep 4, 2024
| @@ -13,14 +15,12 @@ keywords: "docker, documentation, about, technology, deprecate" | |||
| will be rejected. | |||
| --> | |||
|
|
|||
| # Deprecated Engine Features | |||
There was a problem hiding this comment.
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 🤷♂️
thaJeztah
reviewed
Sep 4, 2024
dvdksn
force-pushed
the
docs-update-titles
branch
from
ed08874
to
34fa116
Compare
thaJeztah
reviewed
Sep 9, 2024
thaJeztah
reviewed
Sep 9, 2024
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
dvdksn
force-pushed
the
docs-update-titles
branch
from
34fa116
to
0fcaffb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 35727626+dvdksn@users.noreply.github.com
- 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)