Commit Graph

13 Commits (b15f2fdfdc629f46ceec6aa3b995158b6b4bc1a5)

Author SHA1 Message Date
Jason Stirnaman 064d9d0a25
chore/api-tags flatten tags (#4191)
* chore(api):

- Replace some x-tagGroups with tags to flatten the navigation and redundant headings.
- Remove unnecessary x-tagGroups from 1.x compat docs.

* chore: remove unused tag-group files.

* chore: update api-docs README

- Document the generate -c flag.
- Cleanup.

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2022-07-12 12:21:35 -05:00
Jason Stirnaman 88d3057f21
fix(api): reimplement Regex to replace shortcode. (#4161)
* fix(api): reimplement Regex to replace shortcode.

- Update README with more detailed instructions for updating API docs.
- Use regular expression instead of string to replace URL shortcode, just in case of extra whitespace or line breaks.
- Look for shortcode in additional nodes, especially Parameters.
- Regenerate docs with URL shortcode replacement.

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update api-docs/openapi/plugins/decorators/replace-shortcodes.js

* Update api-docs/README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2022-06-27 08:53:32 -05:00
Jason Stirnaman afbe39b8a2
Fix/api reference (#3977)
* chore: add decorator to strip trailing slash from path URLs

* chore: openapi processing

- remove custom tags and revert to managing tags in influxdata/openapi.
- remove security scheme content; revert to managing in influxdata/openapi.
- delete unused decorator
- fix strip-version-prefix--replace regex
- revert to bold for h4-h6
- use docs-release/influxdb-oss release branch for OSS docs.
- update README

* Update api-docs/README.md

Co-authored-by: sunbryely-influxdata <101659702+sunbryely-influxdata@users.noreply.github.com>

* chore: add instruction for updating the release branch.

* Update api-docs/README.md

* Update api-docs/README.md

* Update api-docs/README.md

* Update api-docs/README.md

* chore: update cloud API spec

- tag updates
- Invokable rename
- Cleanup.

* Update api-docs/README.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

Co-authored-by: sunbryely-influxdata <101659702+sunbryely-influxdata@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2022-04-26 17:16:36 -05:00
kelseiv d674758ec0
base update to 2.2 (#3744)
* base update to 2.2

* draft release notes

* draft InfluxDB 2.2 release notes

* move release notes to new PR

* update api for 2.2

* fix menu items

* Update data/products.yml

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update data/products.yml

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* frontmatter fixes

* Feat/oss v2 2 metrics (#3762)

* feat: copy v2.1 metrics to v2.2.

* feat: new storage metrics in v2.2

* feat: v2.2 storage metrics.

* fix: revert 2.1 paths.

* Update "Get started with tasks" (#3763)

* update get started with tasks, closes influxdata/DAR#272

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* update nats config options, update influxd-flags logic, related to #3766 (#3771)

* updated token create API examples, closes influxdata/DAR#267 (#3773)

* ported scalar values update to 2.2

* Chore/move openapicli process (#3801)

* Internal measurements for monitoring Enterprise (#3698)

* Add 1.21.4 (#3789)

* Add 1.21.4

* Update content/telegraf/v1.21/about_the_project/release-notes-changelog.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Add apt and knot plugins

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* InfluxDB Enterprise 1.9.6 (#3650)

* Document meta-node HTTP access logging (#3486)
* Document `influxd-ctl backup -estimate` flag (#3484)
  Closes #3480
* add new option for SIGTERM (#3496)
* Document `-meta-only-overwrite-force` restore flag for Enterprise (#3487)
* Document `max-concurrent-deletes` option (#3697)
* Update Enterprise cluster metrics: add `openConnections` (#3703)
  Closes #3653
* Remove marketplace offerings from Enterprise
* Use bytes in certain Enterprise config examples (#3743)
* InfluxDB Enterprise 1.9: remove default values from configuration headings (#3759)

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Sam Arnold <sarnold@influxdata.com>

* fix: bad link. (#3793)

* Update products.yml

* Feat/3411 link to cloud limits (#3795)

* feat: link from write error responses to related Cloud limits topics.

* feat: link Troubleshooting writes to Cloud limits.

* fix: grammar.

* Update content/influxdb/cloud/write-data/troubleshoot.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* First updates for the new brand (#3796)

* first pass with new branding, logos, fonts

* updated table font sizes

* removed unnecessary file

* Update assets/styles/layouts/_sidebar.scss

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* a few last style updates

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* chore: move openapi-cli postprocessing to the getSwagger step.

* chore: convert the content generators to functions so they're not executed on import (which broke the linter). Move the generators into the decorators and remove options args to simplify. Update and simplify the README. Update the oss v2.1 contract.

* README

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Sam Arnold <sarnold@influxdata.com>

* port menu url fix from master to 2.2

* Feat/oss 2 2 config (#3774)

* wip: add new server-config CLI command and /api/v2/config path. Fix Operator token doc. (#3523)

* feat: document OSS-only  and . Deprecate assets-path: ""
(closes #3523)

* chore: add toc

* Replace run-time with runtime. (#3774)

* Update content/influxdb/v2.2/reference/cli/influx/server-config/_index.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* formatted all flux examples in influxdb 2.2

* Fix/set tag groups (#3823)

* fix: replacement of Info: in contracts.
fix: add missing const declarations.
fix: add a decorator to remove redundant servers with empty URLs
  -- all servers should be root now since paths are explicit.

* fix: invalid mix of tags as strings and objects in root.tags. Convert all tags to objects with a default description.

* fix: use tag objects instead of mixing strings and objects in x-tagGroups -- fixes validation errors.

* port data retention and deletion updates to 2.2

* ported updated current version shortcode to 2.2

* Feat/3414 v2.2 debug pprof (#3844)

* feat: update API reference for OSS v2.2. Adds /debug/pprof.

* feat: add v2.2 runtime reference.

* fix: update URLs.

* port hardening-enabled config info, closes #3867, closes #3866 (#3873)

* Fix/3855 oss2.2 (#3857)

* fix: update npm example in v2.2. (#3855)

* fix: cardinality for ossv2.2 (#3850)

* updating placeholders in 2.2

* Document `influx remote` and `influx replication` (#3469)

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* ported migration docs into 2.2

* updated edge.js

* porting various minor changes into 2.2

* InfluxDB 2.2 release notes (#3745)

* draft 2.2 release notes
* remove flux lines; regroup other items
* update link to Flux RNs
* update release notes
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
* fix frontmatter
* fix link; update version
* edit
* revert for review clarity
* Update influxdb.md
* note about technical preview & feature overview
* edit from Jason
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
* Updates per Tim H and Sam feedback
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* changes made from feedback
* changed technical preview notes
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
* add link to OSS metrics page
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
* Add security section to influxdb/v2.2/reference/release-notes/influxdb.md (#3898)
* edits from Sam
* edit from sam
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* Update content/influxdb/v2.2/reference/release-notes/influxdb.m
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* edits
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: Sam Dillard <sam@influxdata.com>
* edit from Sam
* edit from Sam
* edits from Tim
Co-authored-by: lwandzura <51929958+lwandzura@users.noreply.github.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Jamie Strandboge <jamie@strandboge.com>
Co-authored-by: Sam Dillard <sam@influxdata.com>

* Recover credentials (#3915)

* draft recover creds
* add relate
* add new option to index
* Update content/influxdb/v2.2/users/recover-credentials.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.2/users/recover-credentials.md
* edit from SamA; add note
* sync headers
* add overview bullets; update links
* context from SamA
* Update content/influxdb/v2.2/users/recover-credentials.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.2/users/recover-credentials.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.2/users/recover-credentials.md
Co-authored-by: Sam Dillard <sam@influxdata.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Sam Dillard <sam@influxdata.com>

* update couple stray versions

* add technical preview to the glossary

* update release date

* fix link

* Add documentation for replications max-age (#3936)

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com>
Co-authored-by: Sam Arnold <sarnold@influxdata.com>
Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MacBook-Pro.local>
Co-authored-by: sunbryely-influxdata <101659702+sunbryely-influxdata@users.noreply.github.com>
Co-authored-by: Dane Strandboge <dane@strandboge.com>
2022-04-06 15:07:21 -07:00
Jason Stirnaman 2bddffb52b
API Ref docs processing (#3337)
* chore: API Reference Docs custom processing. Pulls contracts/ref files and applies custom content (tags, x-tagGroups, securitySchemes, info) before writing results to cloud/ref.yml and v2.0/ref.yml.
Rename source files from swagger.yml to ref.yml to avoid confusion and in case we need to bundle additional specs in the future.
Add an OpenAPI CLI docs-plugin with content and decorators.

* chore: update api-docs/README.md

* fix: add strip-version-prefix to remove /api/v2 added incorrectly to some paths during contract generation - also fixed in openapi repo so future contracts won't need this decorator. Fix server urls. Cleanup.

* chore: update cloud contract.
2021-11-03 14:18:02 -05:00
kelseiv 5f84fb79f8
Add InfluxDB 2.0.9 release notes and new influxd flux-log-enabled option (#3170) 2021-10-11 14:15:39 -07:00
Jason Stirnaman 48505c805c
Fix api docs dependencies (#3229)
* fix: broken install URL. Closes #3122.

* fix: remove redoc-cli from package.json. Set redoc-cli@version specifier in generate-api-docs.sh instead. Remove the requirement to run yarn install just for redoc-cli.

* fix: update README with npx help.

* Update api-docs/README.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix: replace prompt override option for compatibility with npm@6.

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-10-07 14:21:05 -05:00
Jason Stirnaman b594e30782
Revert "Fix api docs dependencies (#3226)" (#3227)
This reverts commit a70df65a79.
2021-10-07 12:09:04 -05:00
Jason Stirnaman a70df65a79
Fix api docs dependencies (#3226)
* fix: broken install URL. Closes #3122.

* fix: remove redoc-cli from package.json. Set redoc-cli@version specifier in generate-api-docs.sh instead. Remove the requirement to run yarn install just for redoc-cli.

* fix: update README with npx help.

* Update api-docs/README.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update api-docs/README.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-10-07 12:01:19 -05:00
Jason Stirnaman f13e34de6d
Install dependencies as project dependencies from NPM repo (#2476)
* Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474)

* Replaced global hugo and yarn installs with project-level yarn install.

* Replaced npm package.lock with yarn.lock (#2474).

* enhancement: update README with instructions for installing NODE.JS dependencies. (#2474)

* updated api doc generator script to use npx

* Update README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update README.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update package.json

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix: indentation. (#2476)

* update: Added separate dependencies list for api-docs.
- Moved redoc-cli to a separate package.json in api-docs. Excluded
api-docs/node_modules from generate-api-docs.sh.
- Updated redoc-cli argument sequence to agree with their docs.
- Updated READMEs.
- Fixed typos.

* update: add api-docs > yarn install to .circleci

* Added language and consistency to code block. Specify where to run the command.

Co-authored-by: Scott Anderson <scott@influxdata.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 12:11:01 -05:00
Scott Anderson 820d369ef8 minor update to api-doc readme 2019-09-30 10:59:25 -06:00
Scott Anderson f474f21c1e api-doc readme and script comments 2019-09-30 10:16:09 -06:00
Scott Anderson 0b6db10137 WIP swagger-generated API docs 2019-09-27 14:42:01 -06:00