This allows to override the default istio/api Git repo URL
(https://github.com/istio/api.git) with something else, for example, a
local directory, hence we can check how the documentation generated from
*.proto is rendered and layouted.
Signed-off-by: Dhi Aurrahman <dio@rockybars.com>
* Update reference docs - remove metrics items
* Fix links
* Actually fix links
* Fix make gen
* Early change from https://github.com/istio/api/pull/1617
* Review comments and rebase
* Update grab_reference_docs to also strip `latest` from url
* Update scripts/grab_reference_docs.sh
Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>
Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>
- Swap the "build" and "gen" terms used in this repo to match
what we do in other repos. "gen" generates a bunch of files, which
is needed by "build". Unlike other repos, the output of "gen" doesn't
need to be checked in to Git however.
- The clean target now cleans the generated directory.
- Makefile.core.mk now defines SOURCE_BRANCH_NAME that decides which
branch we get reference material from. This makes it much simpler to
switch branches.
- Added the "update_all" target which does all the work needed to pull
in the imported content.
- This required fixing the script that grabs the reference docs, it had degenerated in the last
few weeks. While I was there, I made the script work using the build-tools container, and fixed
a bunch of shell script linting warnings.
Partner components (adapters not controlled by the Istio org) are now
called out as such on their page. Component authors have a chance to put
all sorts of info about their component to make it easy for customers
to find and use their component.
- Add the {{< text >}} shortcode as a way to declare code blocks. This shortcode
is intended to hide the subtleties around code blocks. More specifically, it
provides a transparent workaround for the Hugo bug around converting indented
code blocks with lines starting with dashes. It also deals with the special
formatting case we have around command-lines that start with `cat <<EOF`.
- Rename the {{< file_content >}} shortcode to {{< text_file >}} and the
{{< fetch_content >}} shortcode to {{< text_dynamic >}} for consistency in naming.