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

Update docs to match the new triague guidelines #4260

Merged
merged 3 commits into from
Sep 6, 2018

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Jun 18, 2018

Refs to #2673 (comment) and #4180

@@ -111,8 +111,7 @@ label. The reported issue …
in the past or it was decided that the proposed feature will not be
implemented because it does not conform with the overall goal of Read the
Docs. Also if you happen to know that the problem was already reported,
label the ticket with **Status: duplicate**, reference the other ticket
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have the duplicate label anymore

… is a valid enhancement proposal
If the ticket contains an enhancement proposal that aligns with the goals
of Read the Docs, then add the label **Enhancement**. If the proposal
… is a valid feature proposal
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think enhancement is now feature, but we also have Improvement (that's why I removed some examples here)

@@ -208,14 +205,6 @@ few more at hand to further categorize issues.
If the issue is urgent, assign this label. In the best case also go forward to
resolve the ticket yourself as soon as possible.

*Community Effort*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We still have this label. :/ The other PR doesn't actually refer to removing it, it just removed it (unless I am missing something?)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, here is a little of discussion #4180 (comment) and the commit d981892

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I saw that discussion and the commit; it just doesn't seem like dropping the 'Community Effort' label was discussed, it was just included in the commit.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've already started retriaging these issues, but yes, there are still some left. I'm +1 on just removing from the docs for now.

Copy link
Contributor

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! The next step is probably to make a similar doc for core, so we can describe the issue acceptance and milestone workflow.

Do we want to add mention of Improvement here as well?

@agjohnson agjohnson added this to the Documentation milestone Jun 19, 2018
@humitos
Copy link
Member

humitos commented Aug 16, 2018

Do we want to add mention of Improvement here as well?

@stsewd I think this is the only missing piece to merge this PR. Want to write a paragraph for this?

@stsewd
Copy link
Member Author

stsewd commented Aug 16, 2018

@humitos I'll take a look tomorrow morning

@stsewd
Copy link
Member Author

stsewd commented Aug 16, 2018

Done!

@agjohnson
Copy link
Contributor

Thanks for putting this together!

@agjohnson agjohnson merged commit 09ef90f into readthedocs:master Sep 6, 2018
@stsewd stsewd deleted the update-docs-contribute branch September 6, 2018 00:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants