* WIP monolith docs * WIP monolith * updated alpha shortcode * template updates for v3 and pro * SQL & InfluxQL reference docs for Pro and OSS v3 (#5718) * point to shared influxql source files * add sql and influxql references to pro and oss v3 docs * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * ported changes to distributed influxql refs --------- Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * Influxdb3 restructure (#5744) * WIP monolith naming restructure * rebuild homepage * updated broken home links * stabs in the dark * fixed duplicate-oss shortcode * move clustered and cloud-dedicated * clean-up serverless cruft * add distributed product redirects * standarize productPathData * switch back to findRE for productPathData * remove debugging code * move cloud dedicated content * new product dropdown * Jstirnaman/influxdb3 restructure (#5743) * LDAPS and LDAP Client Certificate Docs Add documentation via LDAP sample configuration for LDAPS and LDAP client certificates. These are new features in the yet-to-be released Enterprise 1.11.7 * Update bucket-schema.md ndjson.org goes to some sort of sports betting site. https://jsonlines.org/ is probably a better site. * fix(partitioning): improve clarity and consistency in partitioning, apply suggestions from @reidkaufmann * update shared links to use ambiguous version * WIP monolith docs * template updates for v3 and pro * move clustered and cloud-dedicated * switch back to findRE for productPathData * move cloud dedicated content * chore(influxdb3): port cloud-dedicated URLs from recent commit * chore(influxdb3/clustered): fix and update links * removed merge cruft --------- Co-authored-by: Geoffrey Wossum <gwossum@influxdata.com> Co-authored-by: Daniel Lo <wilburlo@gmail.com> Co-authored-by: Scott Anderson <scott@influxdata.com> --------- Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Geoffrey Wossum <gwossum@influxdata.com> Co-authored-by: Daniel Lo <wilburlo@gmail.com> * added and styled alpha banner, updated producted selector styles and js * updated alpha link styles * updated discord link text * updated alpha message * fix page title * Initial Files * Initial Files * InfluxDB 3 Enterprise CLI docs (#5745) * WIP influxdb3 cli * fix page title * influxdb3 enterprise cli * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> --------- Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * fix(js): initialize CodePlaceholder on content loaded, small refactor toward component pattern. * updated URL modal for core and enterprise * remove testing code on install page * InfuxDB 3 Enterprise configuration options (#5749) * fix page title * add enterprise 3 configuration options * revert command updates to avoid conflicts * updated config option name * CLI updates, reorg, and photos * updated host-id option to writer-id * InfluxDB 3 Core CLI (#5750) * WIP make influxdb3 docs shared * finish making influxdb3 enterprise cli shared * add influxdb3 core cli docs * update config option name * updated host-id to writer-id * updated a few more host-id options to writer-id * InfluxDB 3 Core configuration options (#5752) * added missing enterprise config options * add influxdb3 core config options, update enterprise options * minor fixes in core config options * update search integration data (#5753) * Add shared v3 line protocol doc to Core and Enterprise (#5754) * add shared v3 line protocol doc to core and enterprise * Update content/shared/v3-line-protocol.md Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> --------- Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> * feat: update getting started guides * Update content/influxdb3/core/_index.md * Update content/influxdb3/core/_index.md * update use of 3.0 and v3 to just 3 * add basic download/install instructions (#5756) * chore(monolith): port Enterprise and Core get-started guides to shared for reuse as /index and /get-started * fix(monolith): reapply previous description change * Jts/update Get started for monolith (#5759) * fix(monolith): get-started cleanup (spelling, style, APIs) - Finished Enterprise for now, not ported to Core. * fix(monolith): python sample columns * fix(monolith): Ports edits to Core, misc. fixes * update alpha message * add state to product dropdown items --------- Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> Co-authored-by: Geoffrey Wossum <gwossum@influxdata.com> Co-authored-by: Daniel Lo <wilburlo@gmail.com> Co-authored-by: Peter Barnett <peterbarnett@Peters-MacBook-Pro.local> Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com> Co-authored-by: Paul Dix <paul@pauldix.net> |
||
---|---|---|
.. | ||
influxdb3-cli | ||
influxql-v3-reference | ||
sql-reference | ||
v3-core-get-started | ||
v3-distributed-admin-custom-partitions | ||
v3-enterprise-get-started | ||
README.md | ||
_index.md | ||
v3-line-protocol.md |
README.md
Shared content
This section is for content shared across multiple products and versions.
The /shared/_index.md
frontmatter, marks the /shared
directory and its
children as draft so they
don't get rendered when the site is built, but the contents of each shared
documented is included in pages that use the file as a source
in their
frontmatter.
Use shared content
-
Create a new folder for the content in the
content/shared/
directory. -
Copy the markdown files into the new folder.
-
Remove the frontmatter from the markdown files in the shared directory. If the first line starts with a shortcode, add an HTML comment before the first line, otherwise hugo will err.
-
In each of the files that use the shared content, add a source to the frontmatter that points to the shared markdown file—for example:
source: /shared/influxql-v3-reference/regular-expressions.md
-
In the doc body, remove the shared Markdown text and add a comment that points to the shared file, in case someone happens upon the page in the repo--for example, in
/content/3/core/reference/influxql/regular-expressions.md
, add the following: