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

document Client CLI kn domain #3496

Closed
csantanapr opened this issue Apr 23, 2021 · 12 comments · Fixed by #4209
Closed

document Client CLI kn domain #3496

csantanapr opened this issue Apr 23, 2021 · 12 comments · Fixed by #4209
Assignees
Labels
kind/cli kind/good-first-issue Denotes an issue ready for a new contributor. priority/high
Milestone

Comments

@csantanapr
Copy link
Member

The new version of the kn CLI container a new command domain

The info is included in the release notes but it should properly be documented in the website

It was suggested by @abrennan89 to open an issue in the PR for the release notes blod here

@csantanapr can you please open a docs issue for kn domain to get it properly documented in the site so it's not only explained here?

/assign @rhuss

@rhuss
Copy link
Contributor

rhuss commented Apr 23, 2021

Is this something I could actively drive or is it more about delivering input for the documentation and the docs creation happens by somebody else ?

Happy to do either, if I know where to put this documentation to.

@abrennan89
Copy link
Contributor

Note to self: Related to knative/ux#39

@abrennan89
Copy link
Contributor

@rhuss either is fine - do you have draft info for docs for this, or want to take this issue and add a PR yourself?

@rhuss
Copy link
Contributor

rhuss commented Jul 5, 2021

Let me pick this issue and write a documentation PR.

@snneji
Copy link
Contributor

snneji commented Jul 21, 2021

/priority high

@abrennan89
Copy link
Contributor

Bump @rhuss - any progress on this one? Thanks!

@rhuss
Copy link
Contributor

rhuss commented Sep 1, 2021

@abrennan89 thanks for the reminder. I know you will be angry with me 🙇 :) , but could you give me a quick pointer where to add the PR for the documentation ? (I mean to which file) . Thanks and apologies to bug you with this question, but the location is probably not https://knative.dev/docs/client/ ?

@abrennan89
Copy link
Contributor

lol I'm not angry, don't worry 😄 thanks for getting back to me!
I would be inclined to say https://knative.dev/docs/developer/serving/services/custom-domains/ since you're right, there's not really a client reference guide so to speak, we tend to just add kn commands where they fit in procedures. Feel free to ping me on Slack if you need any additional help.

@rhuss
Copy link
Contributor

rhuss commented Sep 8, 2021

@abrennan89 to which source file does https://knative.dev/docs/developer/serving/services/custom-domains/ translate ? I can't find it in the docs repo. There I only can find https://github.com/knative/docs/blob/mkdocs/docs/serving/using-a-custom-domain.md which is a completely different document.

@abrennan89
Copy link
Contributor

@rhuss are you sure you're on the correct branch in git and that you have pulled / rebased any changes from upstream? I just checked on my local repo and it's definitely under docs/docs/developer/serving/services/custom-domains.md
image

@rhuss
Copy link
Contributor

rhuss commented Sep 8, 2021

Thanks !

I was on the main branch (which does not contain that file), but it looks like that mkdocs is the default branch in the docs repo. Is there a particular reason why the main branch is not used as default, like for the others Knative repos ?

Screen Shot 2021-09-08 at 17 39 35

@abrennan89
Copy link
Contributor

It's because it just hasn't been moved over yet, the plan was to use mkdocs temporarily.
@omerbensaadon any plans to move us back to the main branch?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cli kind/good-first-issue Denotes an issue ready for a new contributor. priority/high
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants