Commit Graph

47 Commits

Author SHA1 Message Date
Sarah Maddox 10135e0ad8 Tech writer refactor of GCP deployment docs. (#676) 2019-05-01 17:22:17 -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
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
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
Abhishek Gupta 4fb956eff6 Added instructions for deleting KF deployment from Deployment Manager (#445) 2019-01-25 13:39:02 -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
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
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
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
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
Jeremy Lewi 2973d7a5d2 Update the tag to point to v0.3.0 (#249)
* Create a shortcode.
2018-10-08 19:03:31 -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
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
Ankush Agarwal 2debe55a0f Document the service accounts used by Kubeflow (#176)
* Document the service accounts used by Kubeflow

* Update
2018-08-22 19:23:39 -07:00
Ankush Agarwal 4eab8b1d92 Add docs on setting up IAP with private cluster (#173)
* Add docs on setting up IAP with private cluster

* Update
2018-08-21 21:22:41 -07:00
Ankush Agarwal be3fa51243 Add private cluster docs (#165) 2018-08-20 21:20:52 -07:00
Jeremy Lewi 8ccabdd65b Document how to deploy Kubeflow using kfctl. (#158) 2018-08-14 13:26:19 -07:00
Richard Liu 9a33187bf8 Website versioning (#136)
* Add richardsliu to OWNERS in kubeflow/website

* Test website versioning

* Revert "Test website versioning"

This reverts commit 67ea8da003.

* Testing website versioning

* Add richardsliu to OWNERS in kubeflow/website

Test website versioning

Revert "Test website versioning"

This reverts commit 67ea8da003.

Testing website versioning

* Fix css

* Fixing merge errors

* Fix css

* Fix css

* Fix css

* Fix css

* Change master label to latest

* Parameterize links in docs to point to the right version

* Fix shortcode

* Fix shortcode

* Fix shortcodes

* Fix more links

* Fix some more links

* Modify style changes in sass instead of css

* Edit README.md

* Rename latest to master
2018-08-10 05:54:32 -07:00
Lun-Kai Hsu e23eafc6aa Add doc on AVX2 and Haswell (#131)
* Add doc on AVX2 and Haswell

* update

* comment
2018-08-10 05:49:07 -07:00
Jeremy Lewi cf3dca94a7 Improve troubleshooting instructions for GKE. (#126)
* Improve troubleshooting instructions for GKE.

* Add troubleshooting instructions for 404's on central dashboard.
* Add gcloud/kubectl commands for getting backend health status

* Fix indent.

* Fix grammar.
2018-08-03 10:11:41 -07:00
Jeremy Lewi 65db51267a * Fix indentation. (#112)
* * Fix indentation.
* Add warning about not checking service account keys into source control.

* Fix bolding.
2018-08-01 08:31:41 -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
richardsliu 6da6e45323 Fixing some typos and formatting on the GKE instructions page (#87)
* Fixing some typos and formatting on the GKE instructions page

* Formatting website

* Formatting website

* Formatting website
2018-07-16 15:18:37 -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
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
Jeremy Lewi 4f3f6af9ca Add instructions for copying the ksonnet application to your machine. (#64)
* Add instructions for copying the ksonnet application to your machine.

* Add link to user guide.

* Remove whitespace.
2018-06-28 11:39:22 -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
Ankush Agarwal c742141d27 Fix link in gke doc (#54)
Fixes https://github.com/kubeflow/website/issues/48

/assign @jlewi
2018-06-19 10:14:32 -07:00
Abhishek Gupta 6984e65586 Fix theme & GKE doc formatting (#44)
* Fix style for list aligning and fix formatting of gke deployment doc.

* tiny title/description fix.
2018-06-13 22:41:28 -07:00
Jeremy Lewi 69e612728f Add instructions about cloning the ksonnet app into a source repository. (#34)
Related to: kubeflow/kubeflow#912
2018-06-13 16:35:28 -07:00
Sanyam Kapoor 05712d67ed Update all manual commands with automated deploy script (#40) 2018-06-13 15:33:28 -07:00
Kunming Qu d1add62d62 update gke doc (#37)
* update gke doc

* more doc update

* more update
2018-06-13 11:36: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