docs: move website content back to top-level docs/, replace with symlink#4899
Open
mn-ram wants to merge 1 commit intolima-vm:masterfrom
Open
docs: move website content back to top-level docs/, replace with symlink#4899mn-ram wants to merge 1 commit intolima-vm:masterfrom
mn-ram wants to merge 1 commit intolima-vm:masterfrom
Conversation
Move the Hugo site's documentation tree from website/content/en/docs/ back to the top-level docs/ directory so contributors can find it via grep / their editor without having to know the website source layout (per the discussion in lima-vm#4681 and the request in lima-vm#4686). Hugo continues to find the content via a relative symlink: website/content/en/docs -> ../../../docs The existing top-level docs/images/ (used by the Makefile for the PlantUML sequence diagram) and docs/reports/ (audit reports) are untouched. The docs/README.md redirect stub is removed, since docs/_index.md now serves as the documentation root. Also update a stale path reference in pkg/driver/qemu/qemu.go from website/content/en/docs/config/vmtype/qemu.md to docs/config/vmtype/qemu.md. Fixes lima-vm#4686. Signed-off-by: mn-ram <235066282+mn-ram@users.noreply.github.com>
mn-ram
force-pushed
the
move-docs-back-to-toplevel
branch
from
0c84f72 to
f58a0e8
Compare
Contributor
Author
|
The failed |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #4686.
Move
website/content/en/docs/*→docs/*(viagit mv, 100% renames, history preserved).website/content/en/docsis now a symlink to../../../docs, so Hugo continues to find the content tree.docs/README.mdredirect stub removed (replaced bydocs/_index.md).pkg/driver/qemu/qemu.goupdated.docs/images/anddocs/reports/left untouched.go build ./...andgo vet ./...are clean. Hugo build is verifiable in CI.