Commit Graph

35 Commits

Author SHA1 Message Date
Sarah Maddox 6a18035ae7 Getting-started guide: Linked to AWS docs and did a tech writer review (#672)
* Getting-started guide: Linked to AWS docs and did a tech writer review.

* Accepting review suggestion

Co-Authored-By: sarahmaddox <sarahmaddox@users.noreply.github.com>

* Accepting review suggestion

Co-Authored-By: sarahmaddox <sarahmaddox@users.noreply.github.com>

* Accepting review suggestion

Co-Authored-By: sarahmaddox <sarahmaddox@users.noreply.github.com>

* Accepting review suggestion

Co-Authored-By: sarahmaddox <sarahmaddox@users.noreply.github.com>

* Accepting review suggestion

Co-Authored-By: sarahmaddox <sarahmaddox@users.noreply.github.com>

* Accepting review changes
2019-05-02 05:08:23 -07:00
Jeremy Lewi b549c91287 Update Getting started guide for 0.5; (#642)
* Update Getting started guide for 0.5;

* Add a getting started page for on prem users and users with an existing K8s
  cluster. This guide should explain how to use kfctl go binary rather
  than kfctl.sh

* The main getting started page should link to individual getting started pages.

Fix #630 - remove who should consider using Kubeflw.

* Fix type.

* Fix link.

* Fix typos.
2019-04-18 14:19:56 -07:00
Sarah Maddox d743387edc Typographical and link fixes as followup to PR https://github.com/kubeflow/website/pull/568. (#582) 2019-04-04 06:50:52 -07:00
Christos S. Pavlou 2a793035bd Amend the "Getting Started with Kubeflow" page (#550)
* Add MiniKF guide for Kubeflow

Add instructions for installing MiniKF, as presented at Kubeflow Day LA
at SCaLE 17x.

* Amend the "Getting Started with Kubeflow" page

Introduce a different structure for the "Getting Started with Kubeflow"
page, as addressed in issue #548
2019-03-23 11:47:06 -07:00
Sarah Maddox 15baba05d9 Removed broken link from K8s version shortcode (#526)
* Removed broken link from K8s version shortcode.

* Added the word 'version' for consistency with wording around ksonnet min version.

* Updated in response to review comments.
2019-03-08 12:12:54 -08:00
Sarah Maddox 53763c660e Fixes the ksonnet guide (#472)
* Removes obsolete info from ksonnet guide and tidies up some text and links.

* Fixed capitalization of "cloud".
2019-02-11 14:16:00 -08:00
rummens 844a03b5c3 Added instructions to remove KubeFlow again (#464)
* Added instructions to remove KubeFlow again

Added useful instructions on how to remove KubeFlow, I happen to use this if I broke something in KF and want to reset it. It was not in the documentation but I can imagine it helps someone.

* Incopertad change requests from PR
2019-02-10 18:30:51 -08:00
Hougang Liu c9bbf1842c clarify that KFAPP should not be a path (#431) 2019-01-22 11:10:04 -08:00
Sarah Maddox 8a79c998c9 Refactoring the left-hand navigation panel. (#406)
* In progress: Refactoring the left-hand navigation panel.

* Added .description to section index pages.

* Removed the redundant Components Overview as the new index page of the components section does a better job.

* Added redirects for the files I've moved/deleted.

* Fixed the URLs in all doc links.
2019-01-18 11:20:24 -08:00
Carmine Rimi 2a4e77c47f Updated instructions for Microk8s getting started (#398)
This branch/pull request replaces PR #391, which was closed due to
errant rebase.

This change updates the instructions for installing Microk8s, including
making it clear that Multipass isn't required if the user is already on
a Linux system.
2019-01-07 12:57:54 -08:00
Tim Zaman c05cd34576 Update getting started guide by adding zone. (#390)
* Update getting started guide by adding zone.

See: https://github.com/kubeflow/kubeflow/issues/1914

* Update getting-started.md
2019-01-04 10:09:18 -08:00
Sarah Maddox a1d1521658 Evaluating the Docsy theme - ready for review (#303)
* Initial commit of Docsy theme.

* Moved Docsy to the themes directory.

* Updated theme config and shortcodes for Docsy theme.

* Fixed order of TOML entries - tables must go last.

* Ad nil checks for menus and footer links

This commit also bumps `netlify.toml` to a newer Hugo version, as variable overwrites needs Go 1.11. It can be made to work with older Hugo's, but ...

See https://github.com/gohugoio/hugo/issues/5461

* Fix duplicated params definition

* Check in JS resources as workaround to Netlify build issue #182 (unable to build from Hugo extended version).

* Still trying to fix the Netlify build problem.

* Netfify build issue - adding dependencies.

* Initial commit of index files to define Docsy toc.

* Added pipelines index file for Docsy toc.

* Adjusts page front matter for the 'About' section.

* Removed resources and guild modifications that were supposed to fix Netlify build issue.

* Added the package-lock JSON file needed by npm.

* Updated the package-lock JSON file updated by npm.

* Added the 'resources' directory after local 'extended' Hugo build.

* Adjusted page front matter for the 'Components' section.

* Adjusted page front matter for rest of the 'Guides' section.

* Adjusted page front matter for the 'Getting Started' section.

* Removed 'docs' menu config from config file.

* Moved top-level index page and 404 page out of kf theme into project.

* Initial version of list pages for the docs.

* Added the 'resources' directory to gitignore, as we don't want everyone updating it unless they mean to.

* Add a .gitattributes file to ignore the resources files in diffs and merge conflicts.

* Minor clarification in config comment.

* Minor fixes.

* Removed the kf theme.

* Forcing commit of resources.

* Added Kubeflow colours to top nav.

* In progress: Adding the versions menu in the top nav.

* Removed the word 'default' from the custom CSS variable definitions.

* Got the version selector working in the navbar.

* Fixed URL variable for version dropdown.

* Trying a quick fix to get Netlify to recognise updated styles.

* Didn't work. Reverting change.

* Removed unneeded CSS classes.

* Work in progress: Rebuilding the home page in Docsy.

* Work in progress: Rebuilding the home page in Docsy.

* Home page in progress: Added background image and more styling.

* Updated footer for Docsy theme.

* Changed colour of 'info' style for down-arrow on home page.

* Fixed copyright statement to match change in master.

* Moved favicons to right place so browser picks them up.

* Regenerated resources files.

* Fixed the link for editing pages in GitHub.

* In progress: styling for landing page.

* Finished styling for landing page.

* Regenerated the resources files.

* Fixed down-link on landing page.

* Improved styling of logo.

* Fixed logo styling except for mobile.

* Fixed logo styling on mobile.

* Tweaking the logo styles.

* Adding the nav CSS.
2019-01-03 13:15:09 -08:00
Michelle Casbon a72574a3aa Fix indentation in Resources section (#382)
Add Pipelines codelab
2018-12-28 19:03:54 -08:00
Abolfazl Shahbazi 859c5bd068 Making the getting started docs more clear around environment variabes and their usage (#277)
* Making the getting started docs more clear around environment variables and their usage

* Add a small note around KFAPP dir name in gitops-for-kubeflow.md doc

* Remove KUBEFLOW_REPO and replace it with KUBEFLOW_SRC since it is reserved for kfctl.sh
2018-11-11 22:49:59 -08:00
Abolfazl Shahbazi c3e821356c Modify content to make deployment using download.sh vs deploy from source a bit more clear (#267)
* Modify content to make deployment using download.sh vs deploy from source a bit more clear

* No need to KUBEFLOW_REPO and only use KUBEFLOW_SRC environment variable
2018-10-23 22:57:56 -07:00
Matt Rickard f71ab49da4 Fix typos (#255) 2018-10-09 13:55:30 -07:00
Jeremy Lewi 2973d7a5d2 Update the tag to point to v0.3.0 (#249)
* Create a shortcode.
2018-10-08 19:03:31 -07:00
David Aronchick 54a6eea435
Update getting-started.md 2018-09-13 10:15:00 -07:00
Akado2009 61955352d8 Blog posts added (#201)
* blog posts added

* Renamed + moved
2018-09-04 14:19:35 -07:00
Sarah Maddox 86c9cffa23 Doc UX improvements (#182)
* Improved the intro to the guides section in the 'Requirements' doc.

* Smoothed out the UX in the getting-started guide.

* Smoothed out the UX in the GKE getting-started guide.

* Added more clarifications around branding and further UX tidy-ups.

* Fixed one more broken link.
2018-08-29 10:47:42 -07:00
Sarah Maddox fa6d5aac0a Added shortcodes for minimum ksonnet and Kubernetes versions. (#168)
* Added a shortcode for minimum required ksonnet version.

* Added a shortcode for minimum required Kubernetes version.

* Added a link to the Kubernetes version shortcode.

* Adds a section on shortcodes in the website README.

* Added a bit more about shortcodes to the README.
2018-08-20 18:31:22 -07:00
Carmine Rimi 9327d42252 Add getting-started using Microk8s and Multipass (#118)
* Add getting-started using Microk8s and Multipass

These instructions are similar to minikube, but
leverage multipass as a native hypervisor solution and
microk8s as the kubernetes installation.

* Fix user-guide URL, add local k8s option details

More information provided on what minikube entails, and what multipass /
microk8s entails.
2018-08-15 06:28:00 -07:00
Jeremy Lewi 8ccabdd65b Document how to deploy Kubeflow using kfctl. (#158) 2018-08-14 13:26:19 -07:00
Michelle Casbon c14e920fdb Add links to self-paced scenarios (#150)
* Add links to self-paced scenarios

Clarify cluster setup instructions
Remove broken links

* Remove link to example in Requirements

* Add link to Why we use ksonnet

Use correct capitalization on ksonnet components page
2018-08-13 12:38:14 -07:00
Abhishek Gupta 62eebeb616 Update broken links (#119) 2018-07-31 22:59:38 -07:00
Jeremy Lewi 7e5163e712 Bump the Kubeflow version from 0.2.1 to 0.2.2. (#92)
* Bump the Kubeflow version from 0.2.1 to 0.2.2.

* 0.2.2 includes some fixes to deploy.sh.

Fix kubeflow/kubeflow#1201

* Update the user_guide.

* Fix the user_guide.md
2018-07-16 15:55:38 -07:00
Jeremy Lewi bd993da8fb Update the docs for v0.2.1 (#86)
* Update the docs for v0.2.1

* The getting started process now uses deploy scripts and
  doesn't rely on bootstrapper.

* Get rid of and/or

* Try to fix indent by removing line breaks.
2018-07-12 08:21:28 -07:00
Pete MacKinnon 2e48a37c90 Update getting-started.md (#84)
Bump recommended kf version
2018-07-10 12:43:25 -07:00
Jeremy Lewi 4be20a63a2 Update TFJob docs and document how to upgrade Kubeflow (#71)
* Update TFJob docs.

* Explain how to use the new simple example prototype to generate a job.
* Fix some links to the user_guide.

* Fix user_guide links.

* Fix user_guide links.

* Fix a bunch of broken links.

* Add instructions for upgrading Kubeflow.
2018-06-28 22:03:20 -07:00
Ankush Agarwal 128966b698 Website Structure Changes (#69)
* Website Structure Changes

* Put all docs/ content in  under a subdirectory to make it easy to organize
* Add a [[menu.docs]] in config.toml which organizes docs into sections
* For each docs content frontmatter, add a weight and a parent menu
* Major improvements to SecNav
  * Organize it into sections and pages
  * Highlight the current page in SecNav
* Missing .Params.bref should not crash hugo

* Add aliases so that it doesn't break previous links

* Updates to font size to make page more readable
2018-06-27 14:57:21 -07:00
Pete MacKinnon 19d4da43e2 ks version update in GS guide (#65) 2018-06-22 13:10:06 -07:00
Kunming Qu 0946653d0d add bootstrapper doc to getting-started (#50)
* add bootstrapper doc to getting-started

* handle review feedback
2018-06-18 15:43:30 -07:00
Abhishek Gupta 42bcbceec4 Updated minikube deployment document (#47)
* Updated minikube deployment document

* fix typo
2018-06-15 19:00:35 -07:00
Abhishek Gupta 64db32645e Make drafts accessible (#39) 2018-06-13 10:16:28 -07:00
Abhishek Gupta 62b9fbba7a Incorporate new Kubeflow site design into the hugo theme (#38)
* Landing page, and single content page basic setup works

* Section Nav fixed, and Content listins on section pages

* Remove legal/privacy links from footer until ready
2018-06-13 10:05:28 -07:00