neo4j-documentation / knowledge-base

Public Neo4j Knowledge Base
https://neo4j.com/developer/kb
21 stars 43 forks source link

Make it configurable to publish on multiple locations (ZD Aura, ZD Enterprise...) #42

Closed ggrossetie closed 4 years ago

ggrossetie commented 4 years ago

Ideally, we don't want to specify the section ids in the AsciiDoc file but rather use meaningful attribute names/values:

@cwaddingham suggested that we use:

:enterprise:
:aura:

By default, all articles are published on enterprise (support.neo4j.com) so the attribute enterprise will be defined globally (in the Gradle build task). If we only want to publish on Aura for a specific article, we could use the following syntax:

:enterprise!:
:aura:

It won't affect how the HTML is produced, both Aura and Enterprise are using the same templates to produce HTML from an AsciiDoc file.

ggrossetie commented 4 years ago

The :enterprise: attribute means that we want to publish to https://support.neo4j.com and the :aura: attribute means that we want to publish to https://aura.support.neo4j.com.

By default, it will publish to the "Help Center > Knowledge Base" section:

If we want to publish to another section, we can configure the value of the attribute :entreprise: and/or :aura:. For instance, the following will publish the article in both the "Home Page > Getting Started" section and "Help Center > Knowledge Base" section:

:aura: home-page/getting-started,help-center/knowledge-base