Skip to content

add an option to show open PRs on related doc pages. #4108

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

Closed
ghost opened this issue Aug 8, 2014 · 11 comments
Closed

add an option to show open PRs on related doc pages. #4108

ghost opened this issue Aug 8, 2014 · 11 comments

Comments

@ghost
Copy link

ghost commented Aug 8, 2014

I was heavily bitten by the lack of #3894 . I probably spent 2-4 hours trying to figure out why i coudln't get my custom extension name to work. I disappeared from symfony land shortly before 2.3 was released so i totally didn't know about it.

I'd like to suggest that an entry be added at the bottom of doc pages mention that list open PRs related to that page.

@stof
Copy link
Member

stof commented Aug 8, 2014

hmm, building such list would be very inefficient (it requires getting the diff status for each PR to know the impacted files, and for some files looking at all places where they are included).

then, should the list be updated when a new PR is opened impacting the page, or should it be updated only the next time the doc is rendered online ?

/cc @javiereguiluz

@ghost
Copy link
Author

ghost commented Aug 8, 2014

i was more thinking of relying on github labels and keeping it real broad not as specific as you suggested.

I figured docs would be automatically updated once changes hit , perhaps that is not so?

@weaverryan
Copy link
Member

Sorry you got bit by that @jrobeson :/. I think we should just do a better job of merging things quickly (yes, I know that is very much my responsibility). And in the rare event that we have a long-running or controversial PR for an article, we should manually add a quick note to that chapter pointing to the PR.

@xabbuh
Copy link
Member

xabbuh commented Aug 8, 2014

@weaverryan Is there anything we can do to speed things up a bit? For example, can we introduce a new label which can be added by others mentioning that the "functional discussion" has finished. This would then mean that the community thinks this is ready to be merged. You could then frequently focus on only these pull requests.

@ghost
Copy link
Author

ghost commented Aug 8, 2014

i suggested some automatic solution because i know you are quite busy. although likely the real problem is the bus factor

@weaverryan
Copy link
Member

@xabbuh That's an interesting idea. I do basically try to do that now: focus on what's ready so we can get those merged in. Guys like you and Wouter do a really great job of pushing most PR's to that point :). If we had a label, I could certainly go straight to those and make sure those PR's have a very short wait time. It would then be all of our goal to work when we can to move as many issues to where it can have that label. @wouterj what do you think?

An automatic solution is interesting, though I'm not sure it would be worth the work right now. It would probably need to be done by Javier on symfony.com (something that looks at the files that are modified and updates things based on those).

@wouterj
Copy link
Member

wouterj commented Aug 15, 2014

I think such a label can help, but maybe we have to redesign our current process. I'm thinking about extending the doc team:

  • Give @xabbuh permission to tag PRs and issues (if he wants that of course), which is logical since he's pushing a lot of PRs to this point.
  • Let me merge the "minor" PRs too (typo fixes, CS improvements, code bug fixes, minor clarifications)
  • Let you focus on the bigger PRs, so we can quicker merge these.

In the current process, I see that you try to merge the minor PRs first, which results in less time for the bigger PRs which usually results in a long waiting time for the bigger PRs.

What do you think?

@wouterj
Copy link
Member

wouterj commented Aug 15, 2014

I created 3 labels:

  • In progress (the PR needs some fixes, is WIP, etc.)
  • Finished (the PR is ready to let @weaverryan review/merge it)
  • Stalled (the PR is waiting on something else, e.g. WCM)

@xabbuh
Copy link
Member

xabbuh commented Aug 15, 2014

@wouterj 👍 Just saw it in #3894.

@weaverryan
Copy link
Member

I like it - let's see how it works!

@javiereguiluz
Copy link
Member

I think that we can close this issue. We cannot add this to symfony.com because we don't have the resources to do it. And the solution proposed by @wouterj to apply @jrobeson's idea seems to be working OK.

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

No branches or pull requests

5 participants