Skip to content
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

Add customizable docs to build #28186

Draft
wants to merge 13 commits into
base: master
Choose a base branch
from
Draft

Conversation

hestonhoffman
Copy link
Contributor

What does this PR do? What is the motivation?

Merge instructions

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Mar 17, 2025
Copy link
Contributor

github-actions bot commented Mar 17, 2025

Preview links (active after the build_preview check completes)

Renamed files

@@ -13,6 +13,7 @@ PY3=$(shell if [ `which pyenv` ]; then \
else printf "false"; \
fi)
IMAGE_VERSION="latest"
PROJECT_ROOT := "$(shell git rev-parse --show-toplevel 2>/dev/null || echo $(CURDIR))"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check if this is needed

Makefile Outdated
# so Hugo can include them in the site
build-cdocs:
@echo "Compiling .mdoc files to HTML";
@CI_ENVIRONMENT_NAME=$(CI_ENVIRONMENT_NAME);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this?

hestonhoffman and others added 6 commits March 20, 2025 11:27
* Add scraped options and traits

* Migrate pilot page

* Build cdocs on make start

* Delete old .md file

* Move cdocs build command

* Add the author console build

* Tweak build approach
@github-actions github-actions bot added the Guide Content impacting a guide label Mar 21, 2025
)

* Rename env to platform

* Add debugging capability

* Update cdocs hooks

* Fix TOC rendering bug

* Update tarball

* Move headers to the top level
* Adapt customization menu for small screens

* Ignore .mdoc.md files in the published site
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend Guide Content impacting a guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants