Skip to content

Added a guide for Symfony Docs maintainers #11161

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
wants to merge 7 commits into from

Conversation

javiereguiluz
Copy link
Member

This is for maintainers of this repo, so it doesn't have interest for normal Symfony users.

@OskarStark as the newest doc maintainer, this guide is mainly for you. When you have some time, please read it and report any problem or confusing explanation.

@xabbuh @wouterj @HeahDude as expert maintainers, please check if I missed something important about merging PRs. Two comments:

  • I want to add more things in the future different from merging PRs.
  • I prefer to show comprehensive and basic Git commands for all tasks. If the maintainer is a git expert, they can improve the commands to fit their expertise :)

@javiereguiluz javiereguiluz added this to the 3.4 milestone Mar 14, 2019
Copy link
Member

@wouterj wouterj left a comment

Choose a reason for hiding this comment

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

Great start!

# make sure that your local branch is updated
$ git checkout 3.4
$ git fetch upstream
$ git merge upstream/3.4
Copy link
Member

Choose a reason for hiding this comment

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

Not needed, gh takes care of this

$ git add components/phpunit_bridge.rst
$ git commit -a
$ git push origin
$ git push upstream
Copy link
Member

Choose a reason for hiding this comment

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

If it's during a merge with gh, just re-run gh. It knows it stopped in a merge conflict and continues finishing it's merge proces

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Such an excellent guide @javiereguiluz! I only have one minor remark for now.

@OskarStark
Copy link
Contributor

I always read this article but will do in detail again, later today 👍🏻

@OskarStark
Copy link
Contributor

@javiereguiluz why is this file in the _build dir?

_build/maintainer_guide.rst

@javiereguiluz
Copy link
Member Author

@OskarStark the article has been created in _build because it's completely internal. We don't need (or want) regular contributors to find it ... and we won't render it on symfony.com.

@javiereguiluz
Copy link
Member Author

Thank you all for the reviews. I've made most (but not all) of the requested changes ... and I've merged it to move forward. We can fix and tweak further things later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants