Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
6,905 Commits
219 Branches
0 Tags
167 MiB
JavaScript 38.9%
SCSS 28%
HTML 21.9%
Shell 9.8%
Handlebars 0.7%
Other 0.7%
 
 
 
 
 
 
Go to file
Jason Stirnaman 522aa8ac4d fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 
Done:
- Refactors and improves pytest runs--smaller scripts, leaner Dockerfile and containers, sensitive .env files are kept in a bind mount and not added to any container.
WIP:
- Test accepts a list of files, otherwise tests staged files.
- Reconfigures the product-specific linting to behave more as intended
  - Add product-specific styles with Branding configurations
- Merges various spelling rules into InfluxDataDocs vocabulary for simplicity
- Removes redundant vocabs and terms lists
- Reconfigures vale.sh to lint staged and unstaged paths, using product-specific Vale configs, and report all suggestions, warnings, and errors--intended for "cleanup projects" beyond routine pre-commit checks.
- Updates CONTRIBUTING.md doc, explains how to install dependencies and how to ignore pre-commit hooks
- Removes reliance on npm/npx
- Rename folder, line protocol -> line-protocol
- Update clustered doc
- Replace bucket/measurement with database/table
 		2024-06-07 21:41:34 -05:00
.ci/vale fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 2024-06-07 21:41:34 -05:00
.circleci Docu: fix broken link (#5410) 2024-04-08 16:07:49 -06:00
.github Update new feature issue template 2022-04-14 16:08:59 -06:00
.husky fix(ci): Vale format and custom vocabularies 2024-05-29 17:42:31 -05:00
.vscode chore(ci): Add vale script, configuration, and fixes (#5081) 2023-08-11 13:50:31 -05:00
api-docs Merge remote-tracking branch 'origin/master' into jstirnaman/issue5463 2024-05-16 12:50:53 -05:00
assets document influxql subqueries (#5470) 2024-05-14 13:06:04 -06:00
content fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 2024-06-07 21:41:34 -05:00
data fix(flux): cumulativeSum page not found (#5453) 2024-05-09 16:11:41 -05:00
deploy Upgrade hugo to latest version 0.120.4 (#5241) 2023-11-27 13:39:23 -07:00
flux-build-scripts fix: update flux version script to pull nightly versions from main-2.x 2023-12-04 10:32:21 -07:00
layouts Adding alternative downsampling examples - Using Quix (#5451) 2024-05-16 13:12:15 -06:00
resources Add files via upload (#4395) 2022-10-06 13:32:02 -06:00
shared/text fix broken curl post commands (#5423) 2024-04-15 15:20:24 -06:00
static chore: add test data and improve test runner: 2024-05-29 13:31:31 -05:00
test fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 2024-06-07 21:41:34 -05:00
.gitignore fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 2024-06-07 21:41:34 -05:00
.prettierrc.yaml fix: Authorization, not Authentication, header (#3342) 2021-11-03 16:53:56 -05:00
.s3deploy.yml added font file extensions to s3deploy caching config 2019-01-19 08:30:43 -07:00
.vale.ini fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 2024-06-07 21:41:34 -05:00
CONTRIBUTING.md fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 2024-06-07 21:41:34 -05:00
LICENSE added license and issue template, moved security.md 2019-10-07 10:27:36 -06:00
README.md docs: Add docker compose workflow for running docs locally (#5400) 2024-04-01 12:17:07 -05:00
compose.yaml fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 2024-06-07 21:41:34 -05:00
hugo.staging.toml add JSON page lists for use in the v3 UI (#5363) 2024-03-14 09:32:04 -06:00
hugo.toml add JSON page lists for use in the v3 UI (#5363) 2024-03-14 09:32:04 -06:00
lint.sh fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 2024-06-07 21:41:34 -05:00
package.json fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 2024-06-07 21:41:34 -05:00
test.Dockerfile fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 2024-06-07 21:41:34 -05:00
test.sh fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 2024-06-07 21:41:34 -05:00
yarn.lock fix(ci): improve product-specific linting, update CONTRIBUTING, fix write-data errors 2024-06-07 21:41:34 -05:00

README.md

InfluxDB 2.0 Documentation

This repository contains the InfluxDB 2.x documentation published at docs.influxdata.com.

Contributing

We welcome and encourage community contributions. For information about contributing to the InfluxData documentation, see Contribution guidelines.

Reporting a Vulnerability

InfluxData takes security and our users' trust very seriously. If you believe you have found a security issue in any of our open source projects, please responsibly disclose it by contacting security@influxdata.com. More details about security vulnerability reporting, including our GPG key, can be found at https://www.influxdata.com/how-to-report-security-vulnerabilities/.

Running the docs locally

  1. Clone this repository to your local machine.

  2. Install NodeJS, Yarn, Hugo, & Asset Pipeline Tools

    The InfluxData documentation uses Hugo, a static site generator built in Go. The site uses Hugo's asset pipeline, which requires the extended version of Hugo along with NodeJS tools like PostCSS, to build and process stylesheets and JavaScript.

    To install the required dependencies and build the assets, do the following:

    1. Install NodeJS

    2. Install Yarn

    3. In your terminal, from the docs-v2 directory, install the dependencies:

      cd docs-v2
yarn install

      Note: The most recent version of Hugo tested with this documentation is 0.123.8.

  3. To generate the API docs, see api-docs/README.md.

  4. Start the Hugo server

    Hugo provides a local development server that generates the HTML pages, builds the static assets, and serves them at localhost:1313.

    In your terminal, start the Hugo server:

    npx hugo server

  5. View the docs at localhost:1313.

Alternative: Use docker compose

  1. Clone this repository to your local machine. See how to clone a repository.

  2. Follow the instructions to install Docker Desktop and Docker Compose to your local machine.

  3. Use Docker Compose to start the Hugo server in development mode--for example, enter the following command in your terminal:

    docker compose up local-dev

  4. View the docs at localhost:1313.