incubator-baremaps icon indicating copy to clipboard operation
incubator-baremaps copied to clipboard

Published 20 hours ago • verified publisher icon apache

Document how to report issues in website repo.

Open sebbASF opened this issue 1 year ago • 7 comments

It would be useful to add info to https://github.com/apache/incubator-baremaps-site/blob/main/README.md to say where to report issues with the repo/site.

Better yet would be to enable issues on the repo, as that would make it possible to generate an issue directly from a file location.

sebbASF avatar Oct 19 '24 08:10 sebbASF

Thank you for reporting this issue. Currently, all issues are managed within the incubator-baremaps repository, and we encourage using the "documentation" label to clearly identify documentation-related issues. I hadn't considered the possibility of generating an issue directly from a file location, but we would need to ask the infra team to enable this feature since we don't have admin rights on the repo. Another option is to create a PR directly from the website using the "Edit" button. I clarified the instructions in the README.

bchapuis avatar Oct 19 '24 20:10 bchapuis

  1. The information needs to be added to the README on the baremaps-SITE repository, because that is where the problems are.

  2. you can enable issues in the .asf.yaml file; no need to involve Infra

sebbASF avatar Oct 19 '24 21:10 sebbASF

Thanks for the pointer. Let's enable issues on the baremaps-site repo. I will reopen the issue for now. Still, I think it's good if we encourage visitors to open PRs as soon as possible.

bchapuis avatar Oct 20 '24 09:10 bchapuis

I ammended the main README so that the issues on the baremaps-site repository is properly referenced.

bchapuis avatar Oct 20 '24 10:10 bchapuis

Thanks, however how to report issues with the website is not documented on the website itself.

Separately, it might be worth adding a link to the website repo at the bottom of each page. For example like: https://events.apache.org or even https://community.apache.org which links to the page source (that may not be easy, depending on how the site is built).

sebbASF avatar Oct 20 '24 12:10 sebbASF

Regarding your first comment, I updated the CONTRIBUTING.md file in the baremaps repo to reflect your changes. This file is referenced in the menu of the web site.

On the website, we have two links on the right sidebar. The first one (Questions? Give us feedback) now points to the website's new issue page. The second one (Edit this page) points to the corresponding file in the repository.

Do not hesitate to make a PR if you think this can still be improved.

bchapuis avatar Oct 20 '24 20:10 bchapuis

Regarding your first comment, I updated the CONTRIBUTING.md file in the baremaps repo to reflect your changes. This file is referenced in the menu of the web site.

OK, looks good.

On the website, we have two links on the right sidebar. The first one (Questions? Give us feedback) now points to the website's new issue page.

When I clicked on it, it took me to the code issues page, not the website issues page.

Also, AFAICT these links do not appear on the main page.

The second one (Edit this page) points to the corresponding file in the repository.

That works for me.

sebbASF avatar Oct 20 '24 22:10 sebbASF

I checked the first linked (Questions? Give us feedback) and it now redirects to the correct repository. It may have been a caching problem.

bchapuis avatar Oct 30 '24 17:10 bchapuis