Commit Graph

87 Commits

Author SHA1 Message Date
Jorge 871b046471 getting started guide does not refer ks (#687)
The guide does not refer to ks but it is needed. 
The error can be found here: https://github.com/kubeflow/kubeflow/issues/3132
2019-05-09 20:27:58 -07:00
Karl Weinmeister e7f4d608fa Fix typo in Getting Started on IBM Cloud Private (#691)
* Update modeldb.md to fix samples formatting issue

Added carriage return to fix bullet list rendering.

* Fix typo in Getting Started for IBM Cloud Private
2019-05-09 19:05:57 -07:00
Jin Chi He ff9fc109d4 add get start kubeflow with icp (#684) 2019-05-09 04:56:49 -07:00
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
Sarah Maddox 10135e0ad8 Tech writer refactor of GCP deployment docs. (#676) 2019-05-01 17:22:17 -07:00
Roy Lenferink 44f20b50d3 Resolved typos (#665) 2019-04-28 14:28:20 -07:00
Jiaxin Shan f26dc00089 Create AWS section 2019-04-27 05:46:55 +10:00
Sarah Maddox 4e1d8ab2aa Refactored and significantly updated the Jupyter notebooks docs (#633)
* WIP Initial commit of refactored notebooks section.

* Minor additions.

* Finished draft of notebooks quickstart.

* Renamed some files and clarified the notebooks setup doc.

* Updated the guide to custom notebook images.

* A couple more screenshots plus text refinements.

* Fixed references to JupyterHub throughout the docs.

* Updated in response to review comments.

* One more link fix.

* Clarified auth in custom notebooks doc.
2019-04-18 20:47:54 -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 471d02fc40 Multiplied page weights by 10 to make it easier to add more pages (#637)
* Multiplied page weights by 10 to make it easier to add more pages.

* One more weight adjustment.
2019-04-15 21:07:04 -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
Jeremy Lewi 26efe598f1 Update GKE getting started guide and accessing UIs page. (#568)
* Update GKE getting started guide and accessing UIs page.

* Replace instructions for building kfctl with instructions for
  downloading kfctl prebuilt binaries

* Update the page about accessing UIs.

Fix #529

* Move advantages of running on GKE to the end of the doc.

* Start splitting GKE docs into multiple pages.

* Update the index.

* Split up the GCP docs into multiple pages.

* Bunch of fixes.

* Move the monitoring doc into the Google Cloud docs.

* Move all the GKE docs into the GKE section.

* Restore getting-started guide.

* Provide a reference.

* Fix organization.

* Fix the landing page image.

* Fix image.

* Add next steps.

* Add next steps to each page.

* Restore _index.md

* * Address comments

  setup -> set up
  nextsteps  -> next steps

* Prettify image.

* Add some notes about Ambassador.

* Address comments.

* Add section for deleting Kubeflow.

* Add some fixes.
2019-04-03 21:06:49 -07:00
Hung-Ting Wen a03f884547 Update GKE getting started guide (#563)
* update kfctl doc

* add application default credential

* update app layout

* add context for basic auth

* updates

* add text for storage deployment

* update customizing-gke

* update gcp-e2e

* update troubleshooting-gke

* cloud-filestore

* update private-clusters

* upgrade
2019-03-31 04:38:33 -07:00
Sarah Maddox 949d19c48c Expanded and clarified the GCP setup. (#556)
* Expanded and clarified the GCP setup.

* Updated based on review comments.
2019-03-27 21:48:43 -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
Tom Szumowski 71f123b8ba Add description PROJECT variable (#541)
`${PROJECT}` was not defined in step 2 of the `Deploy Kubeflow on GKE using the command line` section. While it is pretty intuitive for those that use GCP, without a description it can be easy to forget to set it when running the command.
2019-03-16 15:28:55 -07:00
Christos S. Pavlou 4de73e2e62 Add MiniKF guide for Kubeflow (#534)
Add instructions for installing MiniKF, as presented at Kubeflow Day LA
at SCaLE 17x.
2019-03-14 14:39:00 -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 a8349bf84b Clarified the GKE getting-started guide for command line. (#522) 2019-03-07 16:00:07 -08:00
Sarah Maddox b50076add3 Upgrade guide for Kubeflow Pipelines. (#513)
* In progress: Upgrade guide for Kubeflow Pipelines.

* Added more content to the upgrade guide.

* Added a note in the main upgrade guide.

* Tweaked the upgrade guide after testing.

* Better images.

* Fixed a typo in the GKE getting-started guide.

* Updated in response to review comments.
2019-03-07 08:22:58 -08:00
Sarah Maddox 47e927d084 Added direct links to ksonnet downloads and directed all installation guides to the ksonnet page (#499)
* Added direct links to ksonnet downloads and directed all installation guides to the ksonnet page.

* Removed the no-check-certificate option from wget. I don't think we should use this option by default.

* Responded to review comments.
2019-02-25 20:46:42 -08:00
Sarah Maddox a6ad79cf89 Fixes URL in the GKE get-started guide. (#481) 2019-02-13 11:02:08 -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
Abhishek Gupta 4fb956eff6 Added instructions for deleting KF deployment from Deployment Manager (#445) 2019-01-25 13:39:02 -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
Sarah Maddox ddef4d3399 Added styling to the screenshots that needed it (#395)
* In progress: Styling images.

* Styled the remaining screenshots that need it.

* Reverted unwanted change to search JS.
2019-01-07 14:20:32 -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 2ae9eeed25 Clarifies GKE getting-started guide. (#386) 2019-01-03 15:30:50 -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
Sarah Maddox 84c58f3cd8 Clarified use of name fields in OAuth instructions. (#377)
* Clarified use of name fields in Oauth instructions.

* Responded to review comment.
2018-12-22 16:09:54 -08:00
Jin Chi He df1e271642 update typos error from Mikikube to Minikub (#350) 2018-12-12 05:07:39 -08:00
Sarah Maddox 50bb0c8e43 Clarifies how to add an authorized redirect URI. (#352) 2018-12-11 05:58:34 -08:00
Isaac Burbank b45b9576ae Update GKE getting started docs. (#326)
* Update GKE getting started docs.

* Update default <name> description to mention KFAPP.
2018-12-05 15:02:17 -08:00
Sarah Maddox c477a3084b Fixes click-to-deploy instructions. (#299) 2018-11-21 10:09:07 -08:00
Jeremy Lewi 10790ca2b0 Add click to deploy as an option to the website. (#298)
* Add click to deploy as an option to the website.

Fixes: #278

* Add note about permissions.
2018-11-20 13:22:24 -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
Richard Liu 1dacc98ae5 Update stable tag to v0.3.1 (#271)
* Update stable tag to v0.3.1

* Fix minikube version tags
2018-10-25 10:37:28 -07: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
Damon Wang e95f01db3c change KUBEFLOW_SRC to KUBEFLOW_REPO (#256)
change the directory env in comman line
2018-10-14 19:49:19 -07:00
Jeremy Lewi 4ed42ebc73 Fix version in download.sh (#257)
* We want to use KUBEFLOW_TAG in the URL so we use the download.sh script
  on the release branch.
2018-10-10 21:16:34 -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
Abhishek Gupta d03c33bb64 Update Minikube setup for kfctl.sh and setup-minikube.sh (#251)
* Update minikube installation instructions for kfctl and setup-minikube

* typo fix
2018-10-05 09:46:52 -07:00
Jeremy Lewi ee1d49f4f7 Improve the instructions for setting up the OAuth client. (#247)
* Improve the instructions for setting up the OAuth client.

* Add screenshots
* Explain that Authorized Domains may not be an option and explain they
  don't need to set it in that case.
Fix #177

* Address comments.
2018-10-05 06:23:42 -07:00
Sarah Maddox f1e2d46652 Refactors the GKE getting-started guide (#228)
* Refactors the GKE guide.

* Fixed menu structure.
2018-09-17 10:33:05 -07:00
David Aronchick 54a6eea435
Update getting-started.md 2018-09-13 10:15:00 -07:00