Skip to content

Removing some installation instructions #4608

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

Merged
merged 3 commits into from
Dec 20, 2014
Merged

Conversation

weaverryan
Copy link
Member

Q A
Doc fix? no
New docs? no
Applies to all
Fixed tickets n/a

Hi guys!

This removes some duplicate installation instructions. I want less docs, without explaining less :). Duplicate like this is an opportunity to give users more paths for no reason. I'm sure we have more things like this - like details on handling parameters.yml or other things.

Thanks!

it is hosted on `Google code`_ and called ``myproject``:

.. code-block:: bash

$ svn checkout http://myproject.googlecode.com/svn/trunk myproject

4. Copy the Symfony project files in the Subversion folder:
2. Copy the Symfony project files in the Subversion folder:
Copy link
Member

Choose a reason for hiding this comment

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

can't we use the # syntax here? (oh, docbot would be so nice in this case :P)

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 usually avoid it because I know for sure the numbers will work exactly as expected whereas with # I'm never totally sure if a line break might cause the numbers to restart. It's like an extra tool that I just don't care to use - the rare re-numbering is easy anyways

Copy link
Member

Choose a reason for hiding this comment

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

I would prefer # characters cause it makes diffs easier to read on reviews.

Copy link
Member

Choose a reason for hiding this comment

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

Other chapters (the new_project_git one above for instance) are using the # notation already. IMO, we should be consistent

The ``parameters.yml`` file is ignored by svn (see above) so that
machine-specific settings like database passwords aren't committed. By
creating the ``parameters.yml.dist`` file, new developers can quickly clone
the project, copy this file to ``parameters.yml``, customize it, and start
developing.

8. Finally, download all of the third-party vendor libraries by
6. Finally, download all of the third-party vendor libraries by
Copy link
Member

Choose a reason for hiding this comment

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

This is not needed if you used the installer

Copy link
Member

Choose a reason for hiding this comment

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

Maybe we could create a short list of instructions for people using the installer and then an additional list of things that you need to know in case you didn't use the installer.

Copy link
Member

Choose a reason for hiding this comment

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

IMO, this page should only care about the SVN-specific instructions. Even people not using the installer will already have the vendors at this step if they followed the installation instructions linked at the top of this page, as they also ask to install vendors for other installation methods

The vendors was removed because we really need to keep this focused on svn
and not repeat ourselves and create duplicate docs
@weaverryan
Copy link
Member Author

Thanks guys - I've made the updates commented and merged this in. I feel we're still in transition with making sure we have one consistent installation path that is consistently and nicely documented, but we're getting closer :). Cheers!

@weaverryan weaverryan merged commit 3395b50 into 2.3 Dec 20, 2014
weaverryan added a commit that referenced this pull request Dec 20, 2014
This PR was merged into the 2.3 branch.

Discussion
----------

Removing some installation instructions

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | no
| Applies to    | all
| Fixed tickets | n/a

Hi guys!

This removes some duplicate installation instructions. I want less docs, without explaining less :). Duplicate like this is an opportunity to give users more paths for no reason. I'm sure we have more things like this - like details on handling parameters.yml or other things.

Thanks!

Commits
-------

3395b50 Re-wording parameters.yml section and removing note about vendor #4608
9d925ff [#4608] Using #. for numbered bullets
78e08f4 Removing some installation instructions
@weaverryan weaverryan deleted the less-installation-docs branch December 20, 2014 21:22
weaverryan added a commit that referenced this pull request Dec 20, 2014
* 2.3: (27 commits)
  Update forms.rst
  link to the API documentation
  Re-wording parameters.yml section and removing note about vendor #4608
  [#4608] Using #. for numbered bullets
  Changing and -> or based on conversation in #4532
  Changed to definition lists from Book section
  Changed to definition lists
  Fixed heading capitalization to follow the standards
  Changed paragraph to heading
  Changed unordered list to definition list
  Spelling mistake tens to tons
  Update controllers.rst
  Update the_controller.rst
  replace Symfony2 with Symfony
  Linked the PDO/DBAL Session article from the Doctrine category
  Fix indentation of YAML example
  Fixed some code indentation
  Fixed section headers
  Minor grammar fix
  Restored the original section title
  ...

Conflicts:
	book/forms.rst
	book/internals.rst
	components/http_foundation/introduction.rst
	cookbook/map.rst.inc
weaverryan added a commit that referenced this pull request Dec 20, 2014
* 2.5: (30 commits)
  Update forms.rst
  link to the API documentation
  Re-wording parameters.yml section and removing note about vendor #4608
  [#4608] Using #. for numbered bullets
  Changing and -> or based on conversation in #4532
  Changed to definition lists from Book section
  Changed to definition lists
  Fixed heading capitalization to follow the standards
  Changed paragraph to heading
  Changed unordered list to definition list
  Spelling mistake tens to tons
  Removed double `firewall_restriction` entry
  Normalize the method listings on version 2.5
  Update controllers.rst
  Update the_controller.rst
  replace Symfony2 with Symfony
  Linked the PDO/DBAL Session article from the Doctrine category
  Fix indentation of YAML example
  Fixed some code indentation
  Fixed section headers
  ...
weaverryan added a commit that referenced this pull request Dec 20, 2014
* 2.7: (35 commits)
  Update forms.rst
  link to the API documentation
  Re-wording parameters.yml section and removing note about vendor #4608
  [#4608] Using #. for numbered bullets
  Changing and -> or based on conversation in #4532
  Changed to definition lists from Book section
  Changed to definition lists
  Fixed heading capitalization to follow the standards
  Changed paragraph to heading
  Changed unordered list to definition list
  Spelling mistake tens to tons
  Removed double `firewall_restriction` entry
  Normalize the method listings on version 2.5
  Update controllers.rst
  Update the_controller.rst
  replace Symfony2 with Symfony
  Linked the PDO/DBAL Session article from the Doctrine category
  Fix indentation of YAML example
  Fixed some code indentation
  Matching up the index position with the map
  ...
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.

5 participants