35 Commits

Author SHA1 Message Date
Andrew Rynhard
336f983c21 docs: add v0.6 docs
This adds the documentation for v0.6 and removes v0.3 since
it is no longer supported.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2020-06-10 10:39:38 -07:00
Andrew Rynhard
20e721c47a docs: make v0.5 docs the default
This updates links and dropdown menus to point to the v0.5
documentation.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2020-05-27 10:09:47 -07:00
Timothy Gerla
e70b7e3073 docs: fix broken links in components pages (fixes #2117)
- Intra-site docs links need to be relative
- Add nuxt-interpolation to rewrite <a> tags to <nuxt-link> tags
which improves the single-page-app behavior when clicking on internal links.

Signed-off-by: Timothy Gerla <tim@gerla.net>
2020-05-18 08:06:23 -07:00
Timothy Gerla
5348332d26 docs: adjust docs layouts and add tables of contents
- add an auto-generated table of contents with markdown-toc
- docs pages now fill the whole page width; other pages are are 4/5ths wide as before
- clean up and reorganize some styles
- version dropdown moved to the left
- cleaned up the github edit link
- a couple of responsive cleanups
- add page title to HTML title attribute

Signed-off-by: Timothy Gerla <tim@gerla.net>
2020-05-11 10:26:31 -07:00
Timothy Gerla
fdc4bc506c docs: update copyright date
- Update the page footer copyright date to 2020

Signed-off-by: Timothy Gerla <tim@gerla.net>
2020-05-11 07:24:01 -07:00
Timothy Gerla
f59620473e docs: add 0.5 pre-release docs, add linkable anchors, other fixes
- add 0.5 docs branched from 0.4
- add intro page and "get help" pages
- moved Docker and Firecracker into a "Local Clusters" category
- switch to markdown-it from markd for consistency between corp site and docs site
- use markdown-it-anchor to create linkable anchors to sections within a page
- improve urls to use / instead of # for docs pages (WARNING: this breaks old links)
- continue to simplify handling in the Content.vue component
- update JS deps

Signed-off-by: Timothy Gerla <tim@gerla.net>
2020-05-04 16:04:53 -07:00
Timothy Gerla
688efabb93 fix: clean up docs page scripts in preparation for 0.5 docs
- simplify the docs page handling logic and get more nuxt-like
- the handleClick function was vestigial and didn't do anything anymore, remove it
- simplify the Vuex state quite a bit, remove activeDocPath
- clean up github link generation code, and fix #2076

Signed-off-by: Timothy Gerla <tim@gerla.net>
2020-05-02 02:49:19 -07:00
Andrew Rynhard
98e8a69193 docs: default to v0.4
This brings the v0.4 docs out of pre-release status, and updates links
to point to v0.4 docs by default.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2020-04-20 08:21:48 -07:00
Tim Gerla
38eda25398 docs: sidebar improvements and content organization
- Lots of usability improvements to the docs sidebar.
- Headers aren't links to content anymore.
- All of the old index content has been moved to "Overview" pages that have
  explicit links in the docs sidebar.
- Lots and lots of styling cleanups.

Signed-off-by: Tim Gerla <tim@gerla.net>
2020-04-09 14:35:41 -07:00
Andrew Rynhard
5dbc26c7a3 feat: rename osctl to talosctl
This is a rename of the osctl binary. We decided that talosctl is a
better name for the Talos CLI. This does not break any APIs, but does
make older documentation only accurate for previous versions of Talos.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2020-03-20 19:07:39 -07:00
Tim Gerla
d662956449 docs: add a link to the Talos Systems company site to the OSS site's header
- add a separate link to get to the corporate site
- unify some styles between corp and OSS sites
- minor responsiveness fixes

Signed-off-by: Tim Gerla <tim@gerla.net>
2020-01-30 11:54:27 -08:00
Andrew Rynhard
b4dc1526ee docs: remove pre-release from v0.3 docs
This change updates the docs toggle menu to remove "pre-release" from
the v0.3 option.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2020-01-22 09:16:22 -08:00
Tim Gerla
d6f5ff3414 feat: add a basic architectural diagram and a call to action
- add an architecture diagram
- add a call-to-action button on the front page
- clean up some lint issues
- adjust the way the "chips" image is displayed
- move the K8s certified logo to the "Features" section

Signed-off-by: Tim Gerla <tim@gerla.net>
2020-01-10 07:44:47 -08:00
Tim Gerla
4debea6856 feat: allow deep-linking to specific docs pages
This changes the way the sidebar anchors are constructed, and if
there is an anchor in the URL, the Content component will render
the requested page, instead of just the top-level docs page.

Signed-off-by: Tim Gerla <tim@gerla.net>
2019-12-03 07:31:48 -08:00
Andrew Rynhard
714ae3e7c1 docs: add a project dropdown
The dropdown is a better place to group information about the project that
isn't documentation. This places the roadmap and use cases under the project
dropdown.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-11-11 21:48:34 -08:00
Andrew Rynhard
90fd52ad8c docs: fix roadmap layout
This adds margins to the roadmap to make it centered like the docs.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-11-10 15:59:51 -08:00
Andrew Rynhard
83ccbb1d2a docs: add public roadmap
This adds the first pass out our public roadmap. It is intended to be a
living document.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-11-09 05:04:16 -08:00
Tim Gerla
c3a0302f17 docs: various layout and responsiveness fixes
- adjust ul margin to keep the bullets inside the content area
- fix a few docs page responsiveness problems on small screens
- adjust the layout of the logo relative to the docs sidebar
- clean up some vestigial CSS classes

Signed-off-by: Tim Gerla <tim@gerla.net>
2019-11-01 05:58:15 -07:00
Andrew Rynhard
6764170d1a docs: remove v0.2 docs
The v0.2 docs are inaccurate, and in general just bad. Since we made so
many breaking changes in v0.3 I think its better we just hit the reset
button and stick to v0.3 going forward.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-31 14:59:17 -07:00
Andrew Rynhard
6a61b3a1b2 docs: add note on CRNG initialization
This adds a note on the usage of random.trust_cpu to get around slow
boot times due to low entropy.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-30 14:12:31 -07:00
Tim Gerla
8610a3f387 docs: more whitespace, wording, and responsiveness changes
- tweak whitespace between sections
- fix the top menu for small screens
- fix the terminal overlapping on small screens
- tweak wording on a few of the bullet points
- clean up the display of the "certified" logo on small screens
- clean up the "features" grid on medium/large screens

Signed-off-by: Tim Gerla <tim@gerla.net>
2019-10-28 10:50:01 -07:00
Andrew Rynhard
49eaaec9b0 docs: improve asciinema casts
This replaces the existing casts with longer waits so that users can
parse the output.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-21 19:01:26 -07:00
Andrew Rynhard
12c650457e docs: remove header animation
This makes the header a fixed height without animation.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-21 18:34:47 -07:00
Andrew Rynhard
10ab444f71 docs: make the footer bigger
Big footers seem to be in style nowadays. This adds the CNCF log to the
footer and increases the footer height. It also moves the certified
Kubernetes log into the "What is Talos?" section.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-21 12:22:49 -07:00
Andrew Rynhard
e7424eec55 docs: improve landing page terminal
This removes the button hover color and sets the asciinema-player speed
to 1.0.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-21 08:15:20 -07:00
Andrew Rynhard
4f7b89ce6f docs: add API examples to the landing page
This uses the embeddable asciinema-player to show examples of the API in
the landing page.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-20 21:27:32 -07:00
Andrew Rynhard
5914a0c231 docs: improve landing page
This adds a little more space between the landing page items to make the
page a little more readable.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-20 19:13:07 -07:00
Andrew Rynhard
68d0798930 docs: make the sidebar sticky
Instead of floating the sidebar, we want it to be stick so that the
footer doesn't cover the bottom of the sidebar.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-19 20:40:35 -07:00
Andrew Rynhard
06aa63fbb3 docs: change doc content margins and padding
This bumps the content of a doc page up and drops the sidebar down.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-19 20:36:00 -07:00
Andrew Rynhard
d73bbbc9c5 docs: move docs version dropdown to docs page
This moves the documentation version dropdown menu into the
documentation page.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-19 20:14:24 -07:00
Andrew Rynhard
17093416e6 docs: add FAQs page
The FAQs should be pulled out from the documentation as they are
specific to a version of Talos and more of a marketing message. This
adds a dedicated page for the FAQs.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-19 19:26:30 -07:00
Andrew Rynhard
7b801aa1bf docs: add community dropdown
This adds a dropdown menu to the header that makes it easy to find our
community links.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-19 19:01:20 -07:00
Andrew Rynhard
18f3596767 docs: improve dropdown menu
The adds shadow and border radius to dropdown menu.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-19 17:45:12 -07:00
Andrew Rynhard
13d0e5840c docs: add v0.3 boilerplate
This adds the logic for handling multiple versions of documentation, and
adds a copy of the v0.2 docs as a starting point.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-18 23:46:12 -07:00
Andrew Rynhard
655aaa3149 docs: add documentation website
This will allow us to iterate faster on documentation for multiple
versions of Talos.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-18 21:28:40 -07:00