Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use variables (shortcodes) for config URIs #1115

Closed
sarahmaddox opened this issue Sep 3, 2019 · 2 comments · Fixed by #1114
Closed

Use variables (shortcodes) for config URIs #1115

sarahmaddox opened this issue Sep 3, 2019 · 2 comments · Fixed by #1114
Assignees

Comments

@sarahmaddox
Copy link
Contributor

When installing Kubeflow via the CLI, users need to specify a URI of a config file in --config argument.

Example:
kfctl init ${KFAPP} --project=${PROJECT} --config="https://raw.githubusercontent.com/kubeflow/kubeflow/c54401e/bootstrap/config/kfctl_gcp_iap.0.6.2.yaml" -V

  • There are multiple config files available, each for a specific use case (e.g. GCP with IAP, GCP with basic auth, existing k8s with Istio, existing k8s with arrikto).
  • The URI for each config file changes with Kubeflow version, and may even change within a version.
  • Each URI is potentially used in more than one doc.

For the above reasons, it makes sense to specify the URIs in Hugo shortcodes so that (a) it's easy to find all the URIs as they're not scattered around various pages, and (b) we can be sure all docs are using the same config file for a particular use case.

@issue-label-bot
Copy link

Issue-Label Bot is automatically applying the label kind/feature to this issue, with a confidence of 0.78. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

@sarahmaddox
Copy link
Contributor Author

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant