[](https://g.codefresh.io/pipelines/live-docs/builds?repoOwner=codefresh-io&repoName=docs.codefresh.io&serviceName=codefresh-io%2Fdocs.codefresh.io&filter=trigger:build~Build;branch:master;pipeline:5a941be91a89c60001c3fad4~live-docs)

[](https://g.codefresh.io/pipelines/live-docs/builds?repoOwner=codefresh-io&repoName=docs.codefresh.io&serviceName=codefresh-io%2Fdocs.codefresh.io&filter=trigger:build~Build;branch:master;pipeline:5a941be91a89c60001c3fad4~live-docs)

This site is built with Jekyll. Documentation content is written in Markdown format located in './docs'

The site is automatically deployed when commits are merged/pushed in`master`, hosted athttps://codefresh.io/docs/

1. Install[docker-compose](https://docs.docker.com/compose/)

2. Run`docker-compose up`

1. Install[docker-desktop](https://www.docker.com/products/docker-desktop/)

2. Run`dockercompose up`

3. Open`http://localhost:3131` in your browser, and voila!

To compile scss files into css run the command`npm run css` or in the live mode`npm run watch-css`.

4. From the root directory, run`npm run docs-serve-dev` in the command line.

5. Open`http://localhost:19002` in your browser, and voila.

1. In the Enterprise collection, find the document for the ArgoHub collection.

2. In the ArgoHub collection, create a folder structure for the required document.

3. Create a symbolic link to the document inside the required folder in the ArgoHub collection (refer to the "Create a Symlink" section for details).

4. Create a record for the side menu`argohub-nav.yml` that represents the new document.

5. Adjust the document and add conditions for Enterprise and ArgoHub contexts if needed.

6. Adjust the the document links (refter to the "Document Links" section)

7. In the`argohub-redirect-mapping.js`, add a redirect link between the Enterprise and ArgoHub collections.

No actions required - the new content will be automatically reflected in both ArgoHub and Enterprise.

- Repeat step 3.

- Repeat step 6.

- Repeat step 7.

- Repeat steps 2 to 7.

- Repeat steps 2 to 7.

1. In the IDE's file explorer, copy the relative path of the file you want to share.

2. Open the terminal and navigate to the directory where you want to create the symlink.

3. Run the following command:`npm run link <relative-path-from-step-1>`

- By default, all document content appears the same in both Enterprise and ArgoHub contexts.

- To include content for the ArgoHub collection only:`{% if page.layout == "argohub" %}`

- To exclude content from the ArgoHub collection (will appear only in the Enterprise collection):`{% if page.layout != "argohub" %}`

Document links will automatically adjust to the relevant context, eliminating the need for duplication. For example:

Please note that the`{{page.collection}}` argument will only work if the folder structure in ArgoHub and Enterprise collections is the same.

If the paths differ, use an`if` condition to create two separate links.

Image links do not require duplication or modification – they will work seamlessly in both contexts.

The ArgoHub home page and all pages within the ArgoHub collection are excluded from:

- Commandbar HelpHub Search (managed via Commandbar Content Manager).

- Search engines that support the`noindex` rule, such as Google.

When the GitOps client adds an ArgoHub system type cookie, the Documentation site will detect it and initiate an automatic redirect. If you open any page from the enterprise collection, the site will check for an equivalent document in the ArgoHub collection and redirect you there if one exists.

../../../_docs/installation/gitops/shared-configuration.md

../../_docs/getting-started/intro-to-codefresh.md

docs:

output:true

permalink:/:collection/:path/

argohub:

output:true

permalink:/:collection/:path/

defaults:

layout:docs

toc:true

wide:true

-scope:

path:"_argohub"

type:argohub

values:

layout:argohub

toc:true

wide:true

feed:

-title:ArgoHub Introduction

url:"/introduction"

pages:

-title:What is Codefresh?

url:"/intro-to-codefresh"

-title:Installation

url:"/installation"

pages:

-title:GitOps Runtimes

url:"/gitops"

sub-pages:

-title:Shared Configuration Repository

url:"/shared-configuration"

<headerclass="bd-navbar py-2 py-md-0">

class="container-fluid navbar navbar-dark navbar-expand flex-column flex-md-row py-0"

class="navbar-brand mx-0 mx-md-2 d-flex align-items-center"

href="{{ site.baseurl }}/argohub"

onclick="ga('send', 'event', 'Navbar', 'Docs links', 'Home');"

aria-label="Codefresh"

{%- include icons/codefresh-logo.svg width="160" height="auto"

class="align-middle" -%}

<divclass="navbar-nav-scroll order-1 order-md-1 mx-md-auto">

<ulclass="navbar-nav flex-row mx-md-auto">

<liclass="nav-item">

class="nav-link"

href="{{ site.baseurl }}/docs/example-catalog/ci-examples/"

onclick="ga('send', 'event', 'Navbar', 'Docs links', 'Open Examples');"

>Examples</a

<liclass="nav-item">

class="nav-link"

href="{{ site.baseurl }}/docs/whats-new/changelog/"

onclick="ga('send', 'event', 'Navbar', 'Docs links', 'Open Changelog');"

>What's New</a

onclick="window.CommandBar.openHelpHub(); setTimeout(() => {

}, 100)"

class="helpbub-toggler helpbub-toggler--small order-2 order-md-2"

aria-label="Search Codefresh Documentation"

type="button"

<divclass="d-flex align-items-center">

<imgsrc="{{site.baseurl}}/images/icons/search.png"/>

<spanclass="ml-2">Search</span>

<spanclass="helpbub-toggler--hotkey">Ctrl / &#8984; + K</span>

<navclass="collapse bd-links"id="bd-docs-nav">

{%-assigncurrent_page_url=site.baseurl |append:page.url -%}

<ulid="bd-docs-nav-list"class="list-unstyled">

{%-fornavIteminsite.data.argohub-nav -%}

{%ifnavItem.url %}

{%-assigngroup_slug=navItem.url |slugify -%}

{%else %}

{%-assigngroup_slug=navItem.title |slugify -%}

{%endif %}

{%-assignlink=navItem.pages |first -%}

{%iflink.url %}

{%-assignlink_slug=link.url |slugify -%}

{%else %}

{%-assignlink_slug=link.title |slugify -%}

{%endif %}

{%assigngroup_url=site.baseurl |append:'/argohub/' |append:group_slug |append:'/' %}

{%-assignactive=nil -%}

{%-ifcurrent_page_urlcontainsgroup_url -%}

{%-assignactive='active' -%}

{%-endif -%}

<liclass="bd-toc-item bd-nav-links-item {%unlessactive==nil %} {{active }}{%endunless %}{%unlessnavItem.pages.size!= 0%} has-children {%endunless %}">

<aclass="h6 bd-nav-links-item-group bd-toc-link font-weight-bold"

data-size="{{navItem.pages.size }}"

data-href="{{group_url }}{%iflink_slug %}{{link_slug }}/{%endif %}">

{{navItem.title }}

</a>

<ulclass="nav bd-sidenav">

{%-fordocinnavItem.pages -%}

{%ifdoc.urlcontains'/argohub/'%}

{%assigndoc_disabled=true %}

{%else %}

{%assigndoc_disabled=false %}

{%endif %}

{%ifdoc.url %}

{%-assigndoc_slug=doc.url |slugify -%}

{%else %}

{%-assigndoc_slug=doc.title |slugify -%}

{%endif %}

{%assigndoc_url=group_url |append:doc_slug |append:'/' %}

{%-assignactive=nil -%}

{%-ifcurrent_page_urlcontainsdoc_url -%}

{%-assignactive='bd-sidenav-active active' -%}

{%-endif -%}

<liclass="{%unlessactive==nil %} {{active }} {%endunless %} {%ifdoc.sub-pages.size> 0%} has-children {%endif %} {%ifdoc_disabled==true %}disabled{%endif %}">

<ahref="{{doc_url }}"

data-size="{{doc.sub-pages.size }}"

data-doc-slug="{{doc_slug }}"

{%ifdoc_disabled==true %}class="disabled"{%endif %}

>

{{doc.title }}

</a>

{%unlessdoc.sub-pages==nil %}

<ulclass="nav bd-sidenav">

{%-forsub_docindoc.sub-pages -%}

{%ifsub_doc.urlcontains'/argohub/'%}

{%assignsubdoc_disabled=true %}

{%else %}

{%assignsubdoc_disabled=false %}

{%endif %}

{%ifsub_doc.url %}

{%-assignsub_doc_slug=sub_doc.url |slugify -%}

{%else %}

{%-assignsub_doc_slug=sub_doc.title |slugify -%}

{%endif %}

{%-assignsub_doc_url=doc_url |append:sub_doc_slug |append:'/' -%}

{%-assignsub_active=nil -%}

{%-ifcurrent_page_urlcontainssub_doc_url -%}

{%-assignsub_active='active bd-sidenav-active' -%}

{%-endif -%}

<liclass="bd-sidenav-item {%unlesssub_active==nil %}{{sub_active }}{%endunless %} {%ifsubdoc_disabled==true %}disabled{%endif %} {%ifsub_doc.sub-pages.size> 0%}has-children{%endif %}">

<ahref="{{sub_doc_url }}"

{%ifsubdoc_disabled==true %}class="disabled"{%endif %}

>

{{sub_doc.title }}

</a>

{%unlesssub_doc.sub-pages==nil %}

<ulclass="nav bd-sidenav">

{%-forsub_doc_lvl2insub_doc.sub-pages -%}

{%ifsub_doc_lvl2.url %}

{%-assignsub_doc_lvl2_slug=sub_doc_lvl2.url |slugify -%}

{%else %}

{%-assignsub_doc_lvl2_slug=sub_doc_lvl2.title |slugify -%}

{%endif %}

{%-assignsub_doc_lvl2_active=nil -%}

{%-assignsub_doc_lvl2_url=sub_doc_url |append:sub_doc_lvl2_slug |append:'/' -%}

{%-ifcurrent_page_urlcontainssub_doc_lvl2_url -%}

{%-assignsub_doc_lvl2_active='active bd-sidenav-active' -%}

{%-endif -%}

<liclass="bd-sidenav-item {%unlesssub_doc_lvl2_active==nil %}{{sub_doc_lvl2_active }}{%endunless %} {%ifsub_doc_lvl2.sub-pages.size> 0%}has-children{%endif %}">

<ahref="{{sub_doc_lvl2_url }}">

{{sub_doc_lvl2.title }}

</a>

{%unlesssub_doc_lvl2.sub-pages==nil %}

<ulclass="nav bd-sidenav">

{%-forsub_doc_lvl3insub_doc_lvl2.sub-pages -%}

{%ifsub_doc_lvl3.url %}

{%-assignsub_doc_lvl3_slug=sub_doc_lvl3.url |slugify -%}

{%else %}

{%-assignsub_doc_lvl3_slug=sub_doc_lvl3.title |slugify -%}

{%endif %}

{%-assignsub_doc_lvl3_active=nil -%}

{%-assignsub_doc_lvl3_url=sub_doc_lvl2_url |append:sub_doc_lvl3_slug |append:'/' -%}

{%-ifcurrent_page_urlcontainssub_doc_lvl3_url -%}

{%-assignsub_doc_lvl3_active='active bd-sidenav-active' -%}

{%-endif -%}

<liclass="bd-sidenav-item {%unlesssub_doc_lvl3_active==nil %}{{sub_doc_lvl3_active }}{%endunless %}">

<ahref="{{sub_doc_lvl3_url }}">

{{sub_doc_lvl3.title }}

</a>

</li>

{%-endfor -%}

</ul>

{%endunless %}

</li>

{%-endfor -%}

</ul>

{%endunless %}

</li>

{%-endfor -%}

</ul>

{%endunless %}

{%-comment -%}

{%unlessdoc.sub-pages==nil %}

<ulclass="nav">

{%forsectionindoc.sections %}

<li>

<ahref="#{{section.title |downcase |replace:'','-' }}">

{{section.title }}

</a>

</li>

{%endfor %}

</ul>

{%endunless %}

{%-endcomment -%}

</li>

{%-endfor -%}

</ul>

</li>

{%-endfor -%}

</ul>

</nav>

<scripttype="module"src="{{ site.baseurl }}/assets/js/src/argohub-redirect.js"></script>

<scriptsrc="{{ site.cdn.jquery }}"integrity="{{ site.cdn.jquery_hash }}"crossorigin="anonymous"></script>