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

Refresh the First-run instructions. #1314

Merged
merged 3 commits into from
Nov 3, 2014
Merged

Conversation

benallard
Copy link
Contributor

  • Move to pip
  • Don't activate the virtualenv (IMO not necessary)
  • Put less emphasis on docker.
  • Remove the use of tail
  • Refresh the logs (2011 and 2009 !)
  • Explain a bit more what the commands are for.

- Move to pip
- Don't activate the virtualenv (IMO not necessary)
- Put less emphasis on docker.
- Remove the use of tail
- Refresh the logs (2011 and 2009 !)
- Explain a bit more what the commands are for.
@benallard
Copy link
Contributor Author

As I started rephrasing the part about docker, I realised that the rest also was in the need for a refreshment.

@@ -14,148 +14,113 @@ In this tutorial no configuration or code changes are done.

This tutorial assumes that you are running on Unix, but might be adaptable easily to Windows.

For the :ref:`fastest way through in Linux <first-run-docker-label>`, you can use Docker, the Linux container engine. Docker automates all the deployment steps for you.
Thank to virtualenv_, installing buildbot in a standalone environment is very easy. For those more familiar with Docker_, there also exists a :ref:`docker version of these instructions <first-run-docker-label>`. Be warned that Docker can be tricky to get working correctly.

Copy link
Member

Choose a reason for hiding this comment

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

One sentence per line, please

"Thank_s_ to.."

It might be better to move the Docker warning to the Docker page -- it sounds a little scary here in the second paragraph of the Buildbot tutorial.

@djmitche
Copy link
Member

djmitche commented Nov 1, 2014

Sorry for the detailed edits - this is overall a good improvement and update.. thanks!

@benallard
Copy link
Contributor Author

No problems at all ! I wish I had this level of review on my docs more often !!!

- One sentence per line
- Restored the ``code-block``s
- language fix
@benallard
Copy link
Contributor Author

PR updated, we still need to agree on the name for the virtualenv (if that need to change)

@benallard
Copy link
Contributor Author

Let's split the virtualenvs, I agree that it's better (nearer to the reality) !

@benallard
Copy link
Contributor Author

Now updated with two virtualenvs.

@sa2ajj sa2ajj added merge-me and removed needs work labels Nov 2, 2014
@sa2ajj
Copy link
Contributor

sa2ajj commented Nov 2, 2014

👍

sa2ajj pushed a commit that referenced this pull request Nov 3, 2014
Refresh the First-run instructions
@sa2ajj sa2ajj merged commit e8656c3 into buildbot:master Nov 3, 2014
@sa2ajj
Copy link
Contributor

sa2ajj commented Nov 3, 2014

Great update! Thanks.

@benallard benallard deleted the patch-3 branch November 3, 2014 08:50
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.

3 participants