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

404 links on https://cobra.dev/ #1391

Open
jelly opened this issue May 6, 2021 · 13 comments
Open

404 links on https://cobra.dev/ #1391

jelly opened this issue May 6, 2021 · 13 comments
Labels
good-first-issue Issues that a new contributor could make a PR for kind/documentation Documentation of cobra itself

Comments

@jelly
Copy link

jelly commented May 6, 2021

The documentation page contains links to how to setup bash completion / man page completion but those links are 404:

https://cobra.dev/doc/md_docs.md
https://cobra.dev/doc/rest_docs.md
https://cobra.dev/doc/man_docs.md
https://cobra.dev/bash_completions.md

@github-actions
Copy link

github-actions bot commented Jul 6, 2021

This issue is being marked as stale due to a long period of inactivity

@umarcor
Copy link
Contributor

umarcor commented Nov 8, 2021

Duplicate of #1243.

@johnSchnake
Copy link
Collaborator

It may have been a duplicate but the other issue is now closed whereas the broken links remain. Still needs fixed it seems.

@johnSchnake johnSchnake added kind/documentation Documentation of cobra itself good-first-issue Issues that a new contributor could make a PR for needs PR and removed kind/stale labels Feb 15, 2022
@jpmcb jpmcb removed the needs PR label Feb 23, 2022
@karansuryadevra
Copy link

Hey @johnSchnake ,
Is this issue still open to be fixed?

@fseesink
Copy link

In the Using the Cobra Generator section, the link in the sentence

Here you can find more information about it.

is pointing to a non-existent page. This is due to the fact they are trying to go to

https://github.com/spf13/cobra/blob/master/cobra/README.md

when it should be

https://github.com/spf13/cobra-cli/blob/main/README.md

@fseesink
Copy link

Since we're on the subject, the entire page could use a little love and attention. It feels like maybe the framework is getting a lot of work/changes, but the website isn't keeping up.

The main page makes reference to the cobra command, when apparently it is now cobra-cli. And trying to follow the instructions on that main page leads to heartache if you don't spend time digging around. (I know, as I just started tinkering with this today. I got it sorted, but no thanks to this page.)

Also, the example code provided in the snippets is often incomplete, lacking package statements, etc. For those who aren't able to get the cobra-cli confusion sorted and try to use this framework manually, they are also in for a world of hurt if they try copy/pasting the snippets into the files and just using that as a baseline.

@davidlopezre
Copy link

Hey!

I noticed the docs in this GitHub repo are updated more frequently than the website. I think the docs in this repo are more likely up to date as they are next to the code. Also, it would be less confusing to have a single source of documentation. So, I wonder if we should remove the docs from the website and link to the GitHub README.

cc: @marckhouzam sorry for the direct mention, wanted a contributor opinion. I am happy to work on this but want to check if it sounds good to you.

@Parthiv-M
Copy link

Hi, this sounds super relevant as I fell prey to a couple of the stale links myself. Open to working on this if there's confirmation about working on this issue :)

@umarcor
Copy link
Contributor

umarcor commented Aug 6, 2023

See #1984.

@mloskot
Copy link

mloskot commented Dec 29, 2023

I'm new to Cobra and the 404-s seem quite unhelpful. Is there any chance this can be fixed soon?

@marckhouzam
Copy link
Collaborator

@umarcor has been kindly trying to fix this for a while, and the maintainers have finally got time to look into the proposed PRs. I’m hoping this will be fixed soon.

@pierow2k
Copy link

Wound up here after trying to run down some documentation related to generating a man page. The links on cobra.dev under Generating documentation for your command are still broken.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good-first-issue Issues that a new contributor could make a PR for kind/documentation Documentation of cobra itself
Projects
None yet
Development

No branches or pull requests