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

The github link on the plugins website seems to be wrong. #52

Open
ryubato opened this issue Feb 9, 2022 · 5 comments · Fixed by #53 · May be fixed by #198
Open

The github link on the plugins website seems to be wrong. #52

ryubato opened this issue Feb 9, 2022 · 5 comments · Fixed by #53 · May be fixed by #198
Labels
documentation Improvements or additions to documentation

Comments

@ryubato
Copy link

ryubato commented Feb 9, 2022

Describe your use-case which is not covered by existing documentation.

The github link on the plugins website page seems to be wrong.

https://plugins.jenkins.io/aws-secrets-manager-secret-source/#documentation

as-is: https://github.com/jenkinsci/aws-secrets-manager-secret-source-plugin/tree/main/blob/master/docs/README.md

to-be: https://github.com/jenkinsci/aws-secrets-manager-secret-source-plugin/blob/main/README.md

Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

No response

@ryubato ryubato added the documentation Improvements or additions to documentation label Feb 9, 2022
@chriskilding
Copy link
Contributor

Indeed correct, I've started the fixes here: #53

I have updated the <url>, but I can't see the issue with https://plugins.jenkins.io/aws-secrets-manager-secret-source/#documentation - I visited that link and it showed the documentation as expected.

@ryubato
Copy link
Author

ryubato commented Feb 11, 2022

Indeed correct, I've started the fixes here: #53

I have updated the <url>, but I can't see the issue with https://plugins.jenkins.io/aws-secrets-manager-secret-source/#documentation - I visited that link and it showed the documentation as expected.

Strange. I still get 404 error.

404-aws-secrets-manager-secret-source-github

@chriskilding
Copy link
Contributor

That was because I hadn't merged the PR yet - but I've now merged it, so let's see if it fixes it after the jenkins.io site rebuilds the page. (There may be a bit of a delay for that.)

@chriskilding
Copy link
Contributor

Looks like the https://github.com/${gitHubRepo}/blob/main/README.md URL format once again doesn't work for the GitHub link on the side of the page :/

@Brijeshthummar02
Copy link

https://github.com/jenkinsci/aws-secrets-manager-secret-source-plugin/blob/main/README.md

Replace ${project.artifactId}-plugin with the actual plugin name, aws-secrets-manager-secret-source-plugin, to ensure that it points directly to the main branch’s README.md file, as shown above.

This should provide a consistent link to the repository's main README for accurate and accessible documentation.

@chriskilding i'm working on it and will open a pr soon.

@Brijeshthummar02 Brijeshthummar02 linked a pull request Oct 26, 2024 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
3 participants