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

Updates to docs contributing processes #14590

Closed
1 of 4 tasks
a-mccarthy opened this issue Apr 7, 2021 · 3 comments
Closed
1 of 4 tasks

Updates to docs contributing processes #14590

a-mccarthy opened this issue Apr 7, 2021 · 3 comments
Labels
area/doc Issues to track documentation tasks Stale

Comments

@a-mccarthy
Copy link

a-mccarthy commented Apr 7, 2021

Is your feature request related to a problem? Please describe.

Docs for the Harbor project are kept in the https://github.com/goharbor/website repo.

This issue covers some process improvements to make it easier to submit and manage docs issues. PRs for docs or website improvement should still be filed against the website repo, but it would be easier to manage docs issues and prioritize them with other dev work if the issues are all in the same repo.

Describe the solution you'd like

  1. Disable the website repo to accepting new issues, have all docs related issues filed agains the core harbor repo (this repo)
  2. Migrate all open issues from the website repo to this repo (or close the ones that it doesn't make sense to move)
  3. Create an issue template for docs that captures information needed to update docs or make site improvements and adds the area/docs label by default
  4. Update website repo to require PRs to have at least 1 approving review before merging

There is also a PR open to add a PR template to the repo to help collect information on things like the changes being submitted issue(s) being fixed, #14271

@Vad1mo
Copy link
Member

Vad1mo commented Apr 21, 2021

I thought it would also make sense to add harbor-helm to harbor as well.

@jonasrosland pointed out that there is https://github.com/orgs/goharbor/projects that could be used for issue triage of multiple projects. It already contains harbor and harbor-helm but not website.

Alternative suggestion is to add website to https://github.com/orgs/goharbor/projects.

@jonasrosland
Copy link
Contributor

Looking closer at this, the maintainers are using milestones within the harbor repo for sprint planning, which only works with issues within that repo: https://github.com/goharbor/harbor/milestones
So, there might be a disconnect between the org board and the repo milestones? @renmaosheng Can you chime in here?

@stale
Copy link

stale bot commented Jul 21, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Stale label Jul 21, 2021
@stale stale bot closed this as completed Apr 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/doc Issues to track documentation tasks Stale
Projects
None yet
Development

No branches or pull requests

3 participants