From b6cdb0a5d004a752917bc374989dcb7a0b3b589f Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Wed, 29 Nov 2017 15:36:05 -0500 Subject: [PATCH 1/2] removing a now-tiny article about git setup --- _build/redirection_map | 7 +-- page_creation.rst | 2 + setup.rst | 16 +++++++ setup/new_project_git.rst | 96 --------------------------------------- 4 files changed, 22 insertions(+), 99 deletions(-) delete mode 100644 setup/new_project_git.rst diff --git a/_build/redirection_map b/_build/redirection_map index 1630cf88007..daf23e274b0 100644 --- a/_build/redirection_map +++ b/_build/redirection_map @@ -287,9 +287,10 @@ /cookbook/web_services/php_soap_extension /controller/soap_web_service /cookbook/workflow/homestead /setup/homestead /cookbook/workflow/index /setup -/cookbook/workflow/new_project_git /setup/new_project_git -/cookbook/workflow/new_project_svn /setup/new_project_git -/setup/new_project_svn /setup/new_project_git +/cookbook/workflow/new_project_git /setup +/cookbook/workflow/new_project_svn /setup +/setup/new_project_git /setup +/setup/new_project_svn /setup /components/asset/index /components/asset /components/asset/introduction /components/asset /components/browser_kit/index /components/browser_kit diff --git a/page_creation.rst b/page_creation.rst index 1f8f7eef88a..3f198eda84e 100644 --- a/page_creation.rst +++ b/page_creation.rst @@ -122,6 +122,8 @@ You can now add your route directly *above* the controller: That's it! The page - ``http://localhost:8000/lucky/number`` will work exactly like before! Annotations are the recommended way to configure routes. +.. _flex-quick-intro: + Auto-Installing Recipes with Symfony Flex ----------------------------------------- diff --git a/setup.rst b/setup.rst index 7f7447c2a73..81280e49761 100644 --- a/setup.rst +++ b/setup.rst @@ -73,6 +73,22 @@ by pressing ``Ctrl+C`` from your terminal. You should **NEVER** listen to all interfaces on a computer that is directly accessible from the Internet. +Storing your Project in git +--------------------------- + +Storing your project in git is easy! Just initialize you repository, add everything +and commit: + +.. code-block:: terminal + + $ git init + $ git add . + $ git commit -m "Initial commit" + +Your project already has a sensible ``.gitignore`` file. And as you install more +packages, a system called :ref:`Flex ` will add more lines to that +file when needed. + Troubleshooting: The Requirements Checker ----------------------------------------- diff --git a/setup/new_project_git.rst b/setup/new_project_git.rst deleted file mode 100644 index 26047a58268..00000000000 --- a/setup/new_project_git.rst +++ /dev/null @@ -1,96 +0,0 @@ -.. index:: - single: Set Up; Git - -.. _how-to-create-and-store-a-symfony2-project-in-git: - -How to Create and Store a Symfony Project in Git -================================================ - -.. tip:: - - Though this entry is specifically about Git, the same generic principles - will apply if you're storing your project in Subversion. - -Once you've read through :doc:`/page_creation` and become familiar with -using Symfony, you'll no-doubt be ready to start your own project. In this -article, you'll learn the best way to start a new Symfony project that's stored -using the `Git`_ source control management system. - -Initial Project Setup ---------------------- - -To get started, you'll need to download Symfony and get things running. See -the :doc:`/setup` article for details. - -Once your project is running, just follow these simple steps: - -#. Initialize your Git repository: - - .. code-block:: terminal - - $ git init - -#. Add all of the initial files to Git: - - .. code-block:: terminal - - $ git add . - - .. tip:: - - As you might have noticed, not all files that were downloaded by Composer in step 1, - have been staged for commit by Git. Certain files and folders, such as the project's - dependencies (which are managed by Composer), ``parameters.yml`` (which contains sensitive - information such as database credentials), log and cache files and dumped assets (which are - created automatically by your project), should not be committed in Git. To help you prevent - committing those files and folders by accident, the Standard Distribution comes with a - file called ``.gitignore``, which contains a list of files and folders that Git should - ignore. - - .. tip:: - - You may also want to create a ``.gitignore`` file that can be used system-wide. - This allows you to exclude files/folders for all your projects that are created by - your IDE or operating system. For details, see `GitHub .gitignore`_. - -#. Create an initial commit with your started project: - - .. code-block:: terminal - - $ git commit -m "Initial commit" - -At this point, you have a fully-functional Symfony project that's correctly -committed to Git. You can immediately begin development, committing the new -changes to your Git repository. - -You can continue to follow along with the :doc:`/page_creation` article -to learn more about how to configure and develop inside your application. - -.. include:: _vendor_deps.rst.inc - -Storing your Project on a remote Server ---------------------------------------- - -You now have a fully-functional Symfony project stored in Git. However, -in most cases, you'll also want to store your project on a remote server -both for backup purposes, and so that other developers can collaborate on -the project. - -The easiest way to store your project on a remote server is via a web-based -hosting service like `GitHub`_ or `Bitbucket`_. Of course, there are more -services out there, you can start your research with a -`comparison of hosting services`_. - -Alternatively, you can store your Git repository on any server by creating -a `barebones repository`_ and then pushing to it. One library that helps -manage this is `Gitolite`_. - -.. _`Git`: http://git-scm.com/ -.. _`Symfony Standard Edition`: https://symfony.com/download -.. _`git submodules`: http://git-scm.com/book/en/Git-Tools-Submodules -.. _`GitHub`: https://github.com/ -.. _`barebones repository`: http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository -.. _`Gitolite`: https://github.com/sitaramc/gitolite -.. _`GitHub .gitignore`: https://help.github.com/articles/ignoring-files -.. _`Bitbucket`: https://bitbucket.org/ -.. _`comparison of hosting services`: https://en.wikipedia.org/wiki/Comparison_of_open-source_software_hosting_facilities From 770932f01cab73df4fb783834d3d32c02052e632 Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Wed, 29 Nov 2017 15:41:45 -0500 Subject: [PATCH 2/2] removing bad link --- setup.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/setup.rst b/setup.rst index 81280e49761..f23faf76ed2 100644 --- a/setup.rst +++ b/setup.rst @@ -183,7 +183,6 @@ Go Deeper with Setup :glob: setup/homestead - setup/new_project_git setup/built_in_web_server setup/web_server_configuration setup/composer