See https://web.dev/external-anchors-use-rel-noopener/
Using noopener, as that addresses the security issue. "noreferer" blocks
the REFERER header, which may still be useful for some target URLs.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This replaces the JavaScript link fix script with a custom plugin,
based on the jekyll-relative-link plugin, and modified so that it
can be used as Liquid "filter".
While it borrows from the jekyll-relative-links plugin, it takes some shortcuts;
- We use the code from jekyll-relative-links plugin to find/extract
links on the page
- Relative links are converted to absolute links, using the path of
the markdown source file that's passed as argument
- After conversion to an absolute link, we strip the ".md" extension;
no attempt is made to resolve the file that's linked to. This is
different from the jekyll-relative-links plugin, which _does_ resolve
the linked file. This functionality could be added in future by
someone who has more experience with Ruby.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The JavaScript "link fix" looks to be only needed for pages
where Markdown is included, and which contain relative links.
Now that we modified all local includes to use absolute links,
the only location where links are not properly generated, is
in the reference documentation.
If broken links are found elsewhere in the website, those links
are legitimately broken, and should be fixed in the markdown
source, not fixed-up afterwards.
This patch moves the javascript to the cli.md include, so that
the script is only run on the reference pages instead of on every
page.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
When generating HTML pages, Jekyll will generate a directory named after the name
of the Markdown file, and generate an index.html file inside that directory. For
example, for a markdown file named /foo/bar/mypage.md, Jekyll generates a HTML
file named /foo/bar/mypage/index.html.
This means that all links relative to mypage.md, and expect those links to be
relative to the /foo/bar/ directory, will actually end up being relative to
/foo/bar/mypage/.
Unfortunately, Jekyll / Liquid does not have a variable that holds the parent
directory of the _markdown_ file, so we have to generate it by taking `page.path`
(which holds the absolute path of the markdownfile), and remove the filename from
that path.
After generating that path, we prepend that path to URLs linking to related
commands (parent commands and child commands), as all reference files are in the
same path.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Removing this "check" because it made the template difficult to
read, and duilding the docs won't fail if these values are missing.
If a page is empty, it's probably fast to find why anyway.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
- remove some redundant whitespace
- use "remove_first" instead of "replace", because the strings to
replace should only occur once.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
We cannot use relative links in includes, because:
- The jekyll-relative-links, is not called on includes, so
markdown-links are rendered as-is.
- These files are included in various locations on the website;
because of that, it's not possible to compose a relative link
to other Markdown files, so we're falling back to using absolute
URLs, relative to the root of the website.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The base command didn't have a description in the YAML file.
Instead of fixing that up in the template, this was fixed upstream.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Stash computed data in a variable
To avoid computing `site.data[include.datafolder][include.datafile]` multiple times for the same context.
* Revert change to hard-tab whitespace
Some commands provide a long list of options, which may
"hide" the examples section. To help discoverability, add
an anchor-link to the examples section (if present).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The extended description usually provides a good introduction to
the command, which likely is useful to read before heading to
more detailed information (such as "which options does this command
have")
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
For some commands, the list of "related" commands is lenghty, therefore
hiding the extended description and examples below the fold, which is
not ideal.
This patch moves the "parent command", "child commands", and "related
commands" sections to the bottom of the page.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Update CLI template for "enterprise-only" commands/plugins
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* reference: mark "assemble" subcommands as enterprise-only
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* reference: mark "cluster" subcommands as enterprise-only
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* reference: mark "registry" subcommands as enterprise-only
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* reference: mark "template" subcommands as enterprise-only
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Add features to CLI ref template
- Differentiate CLI experimental from daemon experimental
- When the whole command is experimental, point to docs for
how to get it to show up
- Make badges links where possible
- Add tooltips to badges for more context
- Document in the test.md how to make badges into links and how to use tooltips
* Go back to small /edge
* Update site front page
Add info about Editions
Reorganize components
Update headings
* Move logic of fetching content to a script
* Add v1.28 API
* Add info about versioned API
Sebastiaan van Stijn
Ashwin Maroli
Sebastiaan van Stijn
Adrian Plata
Adrian Plata
Maria Bermudez
Misty Stanley-Jones
Misty Stanley-Jones
John Mulhausen
French Ben