1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-14 11:57:51 +00:00
Commit graph

15 commits

Author SHA1 Message Date
Markus Lehtonen
d0d9c899c9 docs: mark release as unsupported 2023-04-14 13:41:10 +03:00
Markus Lehtonen
aee10a9b44 docs: show full version number in sidebar
Change the sidebar customization so that the full version (e.g. v0.8.2)
is displayed, instead of the truncated "releae branch version" (e.g.
v0.8) in the top left corner of the page. The items in the version menu
are unchanged and will still show the shorter form.

(cherry picked from commit 4d19e1ab85)
2021-05-19 11:21:35 +03:00
Markus Lehtonen
ab53e7407b docs: add 'release' parameter in config.yml 2021-05-19 11:19:32 +03:00
Markus Lehtonen
67e7658f58 docs: make Github refs point to release branch
Point to the tip of the release branch instead of master (or v0.6.0
tag).
2020-11-02 17:18:02 +02:00
Markus Lehtonen
18691ab658 docs: fix broken refs 2020-11-02 17:18:02 +02:00
Markus Lehtonen
6874ea3b71 docs: add instructions for working on documentation
(cherry picked from commit 0c276b6298)
2020-10-31 00:34:31 +02:00
Markus Lehtonen
1f492784c0 docs: markdown style fixes
Fix markdown syntax and style for content that was moved from README.md
to docs/:

Unify the spelling of master and worker in headings and beginning of
senctences.

Also, env variable for container name in developers-guide.
2020-10-31 00:34:31 +02:00
Markus Lehtonen
5acfaf7ead README: move content over to docs/
Similar re-organization what was done on master branch in
a9d45c80ac.

Move all content from README.md to the Jekyll site under docs/. Also
re-organize it into multiple sub-pages.

Populate README with fresh content turning it into virtually a big link
to the html-based documentation site. Spiced up with super-quick-start
instructions.
2020-10-31 00:34:31 +02:00
Markus Lehtonen
c49e9a835f docs: add landing page and quick-start guide
Virtually a copy-paste from master.
2020-10-31 00:30:55 +02:00
Markus Lehtonen
777144d39b docs: polish the version menu
Only show the dynamic version menu in production environment where it's
available. Local (development) builds only show a stub version menu with
one item.

Also, fix the theme customization. Append version list items to the
correct element in html so that they are displayed correctly. Drop
unnecessary <div/>.

(cherry picked from commit 5295feb1ee)
2020-10-30 16:21:28 +02:00
Markus Lehtonen
c3844a63c5 docs: update the navbar versions menu
Make it hidden, by default. Unify style with other items in the navbar
(making version list horizontal, for example). Show current version next
to the caret mark that opens the menu.

(cherry picked from commit e036d26953)
2020-10-30 08:56:40 +02:00
Markus Lehtonen
f570c5f96c docs: sync navbar from jekyll-rdt-theme v2.0.9
(cherry picked from commit 82f5c89e1a)
2020-10-30 08:56:31 +02:00
Markus Lehtonen
9fe3a14f04 docs: make the list of available versions dynamic
Make the list of available versions dynamic. The items displayed is now
generated with javascript. The parent directory of the site is supposed
to contain versions.js providing getVersionListItems() that returns the
available versions.

The update-gh-pages.sh script is modified to update/create versions.js
on every invocation. It simply lists all directories in the root
directory and adds them to the version list.

(cherry picked from commit c05c6f2e5b)
2020-10-30 08:54:38 +02:00
Markus Lehtonen
46f669fb1a docs: update site setup to release-0.6 branch 2020-10-22 21:51:12 +03:00
Markus Lehtonen
578c8f2b9f docs: copy site setup from master
Copy the virtually empty Jekyll site as a base.

(copied from commit a08fb66fa7)
2020-10-22 21:50:32 +03:00