Skip to content

Commit

Permalink
[#33] Local Deployment section updates for Helix Examples
Browse files Browse the repository at this point in the history
  • Loading branch information
nickwesselman committed Oct 22, 2019
1 parent 54edd4b commit 4e3d929
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 13 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed helix/devops/development/_static/image42.png
Binary file not shown.
Binary file removed helix/devops/development/_static/image43.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 36 additions & 13 deletions helix/devops/development/local-deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Local deployment

One of the most frequently asked questions when working with Sitecore is
whether to develop locally inside the web root or outside. Although the
general recommendation is to work outside the web root, a general
qualification is needed.
general recommendation is to work outside the web root, you should
consider the implications.

There are two major aspects which should lead to choosing one or the
other:
Expand All @@ -15,8 +15,7 @@ importance of this separation cannot be overstated, as it will help in
many aspects in the long run, such as general development,
troubleshooting, upgrades and more. This separation is easier if the
implementation specific files are physically separated from the files in
the standard frameworks etc. On the other hand, tools and processes
might cater for this separation, even when working inside the web root.
the standard frameworks etc.

Generally, if tasks that are repeated frequently become taxing, they
will be circumvented – and this will lead to inconsistencies in the
Expand All @@ -28,15 +27,39 @@ frequency of this task it is imperative that this is easy. Tools and
automated scripts can help this to become almost transparent for the
developer.

.. admonition:: Habitat Example
.. admonition:: Sitecore Helix Examples - TDS

The build system in Habitat includes a number of tasks that will watch
files of a given type and deploy these automatically to the local
instance. This includes changes to assemblies after a build, changes to
.cshtml view files and changes to .css files. Habitat also includes
tasks for deploying all files of a given type.
The TDS version of Helix Basic Company uses the built-in
`capability of TDS <http://hedgehogdevelopment.github.io/tds/chapter4.html>`__
to deploy files to the web root on build. To avoid the need for a
TDS project for modules which do not have associated items, a single
TDS project is used to build and deploy files for all solution modules.

.. figure:: _static/image43.png
.. figure:: _static/basic-company-tds-deployment-sources.png

Figure: All gulp tasks as available through the Visual Studio
Task Runner
Figure: Source web projects for file deployment

.. figure:: _static/basic-company-tds-deployment-build.png

Figure: File deployment location, originating in the ``TdsGlobal.config``

You can also enable the *Content File Sync* feature of TDS to automatically
deploy changes to any content files, such as Razor views and CSS/JS files.

.. figure:: _static/tds-content-file-sync.png

Figure: Configuring *Content File Sync* in *Tools > Options > TDS Options*.

.. admonition:: Sitecore Helix Examples - Unicorn

The Unicorn version of the Helix Basic Company uses the
`Helix Publishing Pipeline (HPP) <https://github.com/richardszalay/helix-publishing-pipeline>`__
open source tooling to enable publishing of the entire Helix solution as a
single unit, and to enable auto-publish to the web root on build.

.. figure:: _static/basic-company-unicorn-hpp-reference.png

Figure: Helix Publishing Pipeline reference in Helix Basic Company - Unicorn

For information on configuring auto-publishing with HPP, see its
`documentation <https://github.com/richardszalay/helix-publishing-pipeline>`__.

0 comments on commit 4e3d929

Please sign in to comment.