1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-15 17:50:49 +00:00
Commit graph

409 commits

Author SHA1 Message Date
Markus Lehtonen
2469db839f docs: markdown style fixes
Fix markdown syntax and style for content that was moved from README.md
to docs/:
- get-started/introduction
- examples-and-demos
- get-started/features
- contributing

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

Also, env variable for container name in developers-guide.
2020-10-29 14:08:16 +02:00
Markus Lehtonen
a9d45c80ac README: move content over to docs/
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-29 14:07:08 +02:00
Markus Lehtonen
2215cfa7c6 docs: add landing page and quick-start guide 2020-10-29 13:29:10 +02:00
Markus Lehtonen
c05c6f2e5b 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.
2020-10-22 21:44:49 +03:00
Markus Lehtonen
194f42f5c9 docs: pin version of jekyll-rtd-theme
Sync our customizations under _includes/ with v2.0.9 of
jekyll-rtd-theme. Also, pin the theme version in order to avoid abrupt
build failures in the future (caused by our customization becoming
incompatible with the rolling latest version).

Also, drop jekyll-rtd-theme from the Gemfile. It's useless there as it's
being mandated by remote-theme setting in _config.yml.
2020-10-22 21:32:17 +03:00
Markus Lehtonen
37cbf80c19 docs: customize the theme to show current version
Show current version (configured in _config.yml) in the sidebar instead
of the latest release from Github.
2020-10-08 10:53:27 +03:00
Markus Lehtonen
611612fd97 docs: add support for versioned documentation
Customize the Jekyll theme to add a simple list of versions.
2020-10-08 10:51:13 +03:00
Markus Lehtonen
5ec91935df Makefile: add rules for building html docs
Add rules for building and serving the html documentation inside a
container.
- 'make site-build' will build the html content unders docs/_site.
- 'make site-serve' builds the site content and serves it at
  http://localhost:4000/
2020-10-08 10:51:13 +03:00
Markus Lehtonen
d8ed7a7131 docs: initial site setup
Bootstrap a new Jekyll site with stub content for testing gh-pages
integration.

Use jekyll-rdt-theme from
https://github.com/rundocs/jekyll-rtd-theme
2020-10-08 10:50:04 +03:00