29 Commits

Author SHA1 Message Date
Timothy Gerla
172a55f2f0 docs: fix a few minor styling issues
- center the "Certified Kubernetes" logo
- adjust margin on an unordered list

Signed-off-by: Timothy Gerla <tim@gerla.net>
2020-05-28 11:12:50 -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
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
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
Tim Gerla
2ee7f5f798 docs: update the website generator's npm packages
- Update the website generator's package list to quiet github.
- Apply a couple of auto-lint fixes.

Signed-off-by: Tim Gerla <tim@gerla.net>
2020-03-20 13:40:47 -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
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
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
8795271c65 docs: update landing page
This updates our note on our commitment to staying in lockstep with
Kubernetes and Linux.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-11-10 15:39:30 -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
96513ac397 docs: fix list-style-position
This sets the list-style-position to inside by default, and overrides
the landing page to use outside. This way we only need to maintain the
CSS for the landing page and not all the other potential places we would
want inside in the future.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-31 14:57:08 -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
Tim Gerla
b324217802 docs: responsiveness fixes and wording changes
- Most of the landing page is responsive on small/medium screens now. There are still
some bugs around the ascii cinema.
- Some wording tweaks, mostly I removed words to make things more concise. Feel free
to edit my edits.
- Simplified a couple of HTML constructs.
- Expanded the "features" section into two rows with a placeholder image for the 6th item.
Happy for feedback.

Signed-off-by: Tim Gerla <tim@gerla.net>
2019-10-24 15:43:23 -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
e3328aa6cb docs: add ephemeral feature note
This adds a feature about how Talos is ephemeral. I feel this is
important to get across to our users.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-21 06:21:58 -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
d9dd55687b docs: show background only on landing page
The background should only be shown on the landing page.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-19 17:27:07 -07:00
Andrew Rynhard
6cc8a8bc04 docs: add landing page
This replaces the Mardown based landing page with a pure HTML approach.
This allows us to have a landing page that is much more impactful.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-10-19 14:45:47 -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