Skip to content

scripts/docs/generate-md.sh: fix location of generate code - #4169

Merged
thaJeztah merged 2 commits into
docker:masterfrom
thaJeztah:fix_mddocs
Apr 9, 2023
Merged

scripts/docs/generate-md.sh: fix location of generate code#4169
thaJeztah merged 2 commits into
docker:masterfrom
thaJeztah:fix_mddocs

Conversation

@thaJeztah

Copy link
Copy Markdown
Member

relates to:

scripts/docs/generate-md.sh: fix location of generate code

Commit 1e3622c (#3991) moved the generator code
to a subdirectory, but forgot to update the markdown version of this script.

docs: regenerate markdown docs

This adds the new aliases that were added in 9b54d86 (#3986)

- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

Commit 1e3622c moved the generator code
to a subdirectory, but forgot to update the markdown version of this script.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This adds the new aliases that were added in 9b54d86
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

Merging #4169 (08a794d) into master (613ab8b) will increase coverage by 0.37%.
The diff coverage is n/a.

Additional details and impacted files
@@ Coverage Diff @@## master #4169 +/- ##
==========================================
+ Coverage 58.66% 59.03% +0.37% 
==========================================
Files 286 288 +2 Lines 24769 24776 +7 ==========================================
+ Hits 14531 14627 +96 + Misses 9355 9265 -90 - Partials 883 884 +1 

@thaJeztah

Copy link
Copy Markdown
MemberAuthor

@crazy-max@dvdksn ptal

@crazy-max

Copy link
Copy Markdown
Member

We should also look at validation of markdown to avoid drifting in the future, see PR description in #3924 (comment)

In follow-up we should also validate docs like it's done in buildx: https://github.com/docker/buildx/blob/88852e2330a200d495342e01783a922a5328d55c/hack/dockerfiles/docs.Dockerfile#L30-L43

@thaJeztah

Copy link
Copy Markdown
MemberAuthor

Yes we should validate this as part of CI; I thought we already did, but indeed it was not yet done (also see #4166 (comment))

I created #4171 for tracking

Let me bring this one in 👍

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@thaJeztah@codecov-commenter@crazy-max