cloudfoundry / cloudfoundry/stratos

Improve stratos usage docs

Open
#3,413 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
TypeScript
Stars
267
Forks
137
Avg merge
5h 14m
Merged PRs (30d)
77

Description

We should review all of our usage docs. Here is an example of something we need to review...
From slack:

Alejandro Bonilla @ABonilla 01:19:16
Neil MacDougall in the docs, when registering a Kubernetes, the docs just say

Enter the URL of the API server for your Kubernetes environment

which is very unclear. Perhaps we should put an example, because it expects the port and everything, not just a URL...

Also, when connecting a Metrics, it says:

Select Metrics from the Endpoint Type dropdown
Enter a memorable name for your environment in the Name field

Check the Skip SSL validation for the endpoint checkbox if using self-signed certificates

Click Finish

but there is also a field for a URL...

Alejandro Bonilla @ABonilla 01:31:56
now I know its lb:4433 but its very vague

Alejandro Bonilla @ABonilla 02:31:38
Neil MacDougall can we allow the option to have a system_shared kubeconfig (of a custom serviceaccount created) to allow all users to view the kubernetes stuff?
Trying for the experience to be easier
I know the current way allows for an easier role/access restriction, but perhaps there is a way to share view-only info? 🤷

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the usage documentation for registering Kubernetes and Metrics endpoints. Review the required URL, port, and SSL fields against the current instructions, and clarify whether the system_shared kubeconfig request is in scope. Done means the relevant setup steps and examples accurately describe the fields users must provide.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.