Commit Graph

8 Commits (docs/clustered/explain-postgresql-dsn-password-with-symbols)

Author SHA1 Message Date
Jason Stirnaman ac4b1c53c8
feat(v3): Restructure API docs for v3 (#5408)
* v3 management API
Fixes #5397

- Adds an API reference doc for the  HTTP management API openapi spec (https://github.com/influxdata/granite/blob/main/openapi.yaml) (Cloud Dedicated only)
- Doesn't fetch changes for any specs except for the Management spec.
- Adds summaries and fixes descriptions in spec overrides.
- Removes versions in spec overrides.
- Adds configuration for generating API reference docs, Hugo frontmatter, setting the default API (for the [product]/api/ URL)
- Restructures `/api-docs` to better allow for multiple APIs (and customizations) per product
- Adds `[product]/api/v2/` docs URL for cloud products (currently set as the "default" API, `[product]/api`)
- Refactors `generate-api-docs` to remove specific conditions and use the new directory structure.
- Redocly update fixes some theme formatting issues

- Tested the following URLs:

   - http://localhost:1313/influxdb/v2/api/
   - http://localhost:1313/influxdb/v2/api/v1-compatibility/
   - http://localhost:1313/influxdb/cloud/api/
   - http://localhost:1313/influxdb/cloud/api/v2/
   - http://localhost:1313/influxdb/cloud-dedicated/api/
   - http://localhost:1313/influxdb/cloud-dedicated/api/v2/
   - http://localhost:1313/influxdb/cloud/api/v1-compatibility/
   - http://localhost:1313/influxdb/cloud-dedicated/api/v1-compatibility/
   - http://localhost:1313/influxdb/cloud-serverless/
   - http://localhost:1313/influxdb/cloud-serverless/api/v2/
   - http://localhost:1313/influxdb/cloud-serverless/api/v1-compatibility/
   - http://localhost:1313/influxdb/clustered/api/
   - http://localhost:1313/influxdb/clustered/api/v2/
   - http://localhost:1313/influxdb/clustered/api/v1-compatibility/

* fix(v3): Remove Management API from menu

* Update api-docs/cloud-dedicated/v2/content/info.yml

* show management api in nav, update nav names

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>
2024-04-09 17:02:12 -06:00
Jason Stirnaman fa9bba758e
chore(api): add API compatibility overview to API ref (#5192)
* chore(api): add API compatibility overview to API ref

- add API compatibility trait tag
- add getswagger -B option to reuse existing contract and prevent fetching
- add /write description

* Update api-docs/cloud-dedicated/ref.yml

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

* Update api-docs/cloud-dedicated/ref.yml

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

* Update api-docs/clustered/ref.yml

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

* Update api-docs/clustered/ref.yml

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

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-10-25 11:35:38 -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 942203d351
2.0 GA and separate Cloud from OSS (#1805)
* WIP separate cloud docs, duplicate content shortcode

* WIP cloud-separation

* WIP separate cloud

* duplicated oss into cloud and am making updates

* moved cloud updates to cloud

* reimplemented duplicate-oss shortcode

* separate Cloud and OSS content in Tools & integ...

* Split OSS and Cloud content for Security & auth

* Split OSS and Cloud content for Manage org

* Split OSS and Cloud - Manage Orgs add'l updates

* various updates, primarily in oss and cloud reference

* split content for notification endpoints

* Move InfluxQL doc to Cloud

- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506

* removed product tags from nav and articles

* WIP separate cloud docs, duplicate content shortcode

* WIP cloud-separation

* WIP separate cloud

* duplicated oss into cloud and am making updates

* moved cloud updates to cloud

* reimplemented duplicate-oss shortcode

* separate Cloud and OSS content in Tools & integ...

* Split OSS and Cloud content for Security & auth

* Split OSS and Cloud content for Manage org

* Split OSS and Cloud - Manage Orgs add'l updates

* various updates, primarily in oss and cloud reference

* split content for notification endpoints

* Move InfluxQL doc to Cloud

- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506

* removed product tags from nav and articles

* New URL switcher (#1720)

* restructured url modal

* rearchitected the url switcher functionality

* add influxdb preference management to url switcher

* create separate pages for querying data

* update weight

* Update flux-repl.md

* Update influx-query.md

* edits f Scott

* move content from explore-metrics to data-explorer

* edits; delete explore-metrics

* edits

* delete file

* remove duplicate content

* add InfluxQLquery examples

* Remove references to "security script"

* draft updates for Band Plot vis

* WIP separate cloud docs, duplicate content shortcode

* WIP cloud-separation

* WIP separate cloud

* duplicated oss into cloud and am making updates

* moved cloud updates to cloud

* reimplemented duplicate-oss shortcode

* separate Cloud and OSS content in Tools & integ...

* Split OSS and Cloud content for Security & auth

* Split OSS and Cloud content for Manage org

* Split OSS and Cloud - Manage Orgs add'l updates

* various updates, primarily in oss and cloud reference

* split content for notification endpoints

* Move InfluxQL doc to Cloud

- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506

* removed product tags from nav and articles

* WIP separate cloud docs, duplicate content shortcode

* WIP cloud-separation

* WIP separate cloud

* duplicated oss into cloud and am making updates

* moved cloud updates to cloud

* reimplemented duplicate-oss shortcode

* separate Cloud and OSS content in Tools & integ...

* Split OSS and Cloud content for Manage org

* Split OSS and Cloud - Manage Orgs add'l updates

* various updates, primarily in oss and cloud reference

* split content for notification endpoints

* Move InfluxQL doc to Cloud

- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506

* New URL switcher (#1720)

* restructured url modal

* rearchitected the url switcher functionality

* add influxdb preference management to url switcher

* URL validation on custom URL (#1763)

* added url validation to custom url form, resolves #1739

* removed placeholder message from custom url form

* updated styles for url selector modal

* Move restore command to `influx` cli, update flags

* Update table for backup

* Remove RC information, update paths for restore, change `backup-path` flag to `input`

* WIP separate cloud docs, duplicate content shortcode

* WIP cloud-separation

* WIP separate cloud

* duplicated oss into cloud and am making updates

* moved cloud updates to cloud

* reimplemented duplicate-oss shortcode

* separate Cloud and OSS content in Tools & integ...

* Split OSS and Cloud content for Security & auth

* Split OSS and Cloud content for Manage org

* Split OSS and Cloud - Manage Orgs add'l updates

* various updates, primarily in oss and cloud reference

* split content for notification endpoints

* Move InfluxQL doc to Cloud

- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506

* removed product tags from nav and articles

* WIP separate cloud docs, duplicate content shortcode

* WIP cloud-separation

* WIP separate cloud

* duplicated oss into cloud and am making updates

* moved cloud updates to cloud

* reimplemented duplicate-oss shortcode

* separate Cloud and OSS content in Tools & integ...

* Split OSS and Cloud content for Manage org

* Split OSS and Cloud - Manage Orgs add'l updates

* various updates, primarily in oss and cloud reference

* Move InfluxQL doc to Cloud

- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506

* New URL switcher (#1720)

* restructured url modal

* rearchitected the url switcher functionality

* add influxdb preference management to url switcher

* WIP separate cloud docs, duplicate content shortcode

* WIP cloud-separation

* WIP separate cloud

* duplicated oss into cloud and am making updates

* moved cloud updates to cloud

* reimplemented duplicate-oss shortcode

* Split OSS and Cloud content for Manage org

* Split OSS and Cloud - Manage Orgs add'l updates

* various updates, primarily in oss and cloud reference

* Move InfluxQL doc to Cloud

- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506

* WIP separate cloud docs, duplicate content shortcode

* WIP cloud-separation

* WIP separate cloud

* duplicated oss into cloud and am making updates

* moved cloud updates to cloud

* reimplemented duplicate-oss shortcode

* separate Cloud and OSS content in Tools & integ...

* Split OSS and Cloud content for Manage org

* Split OSS and Cloud - Manage Orgs add'l updates

* various updates, primarily in oss and cloud reference

* Move InfluxQL doc to Cloud

- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506

* URL validation on custom URL (#1763)

* added url validation to custom url form, resolves #1739

* removed placeholder message from custom url form

* updated styles for url selector modal

* WIP updating InfluxDB OSS naming throughout

* updated canonical shortcode for oss vs cloud, updated 2.0 version numbers on homepage

* updated swagger file to rc4 for 2.0 and cloud

* fixed canonical partial

* Update multi-user Cloud docs

Also adds a heading the note on permissions.

Closes #1764

* Fix table for backup flags

* Update input flag, remove TSI references

* Address PR feedback

* Remove product tag

* Fix DBRP mapping examples (#1776)

* updated dbrp mapping examples in influxql query guide, closes #1774

* removed unnecessarily escaped newline from dbrp mapping example

* add draft rc4 and GA RNs

* cloud and oss name updates

* emphasis production ready

* update curl example

* duplicate oss pages in cloud

* Address PR feedback

* added new aws us east region, resolves #1777 (#1782)

* Add steps for script editor

* Add cloud version

* moved and updated upgrade guides (#1783)

* Fix typos

* update upgrade links

* edits

* Clarify 1m cardinality is initial limit only

* fix typo

* fix date

* Add note on `_internal` database to v1-to-v2 upgrade guide

Closes #1775.

* Update influxdb.md

* fixed broken links throughout cloud docs

* fixed broken links in 2.0 oss

* Address PR feedback

* remove window pushdowns

* updated oss pushdown list

* Add instructions for verifying InfluxDB 2.0 download

* updated latest versions in edge.js

* added flux-0.94.0 to flux release notes (#1790)

* update date and add Flux .94.0 link

* delete broken link to image

* remove auto refresh; not currently in UI

* add duplicate-oss tag to Cloud execute-queries

* highlight diff between Flux and InfluxQL example

* delete extra header

* Generate v1 compatibility API docs (#1789)

* updated swagger generation to generate v1 compat api docs

* restructured api docs

* updated restore flags table

* updated infludb binary urls in oss and cloud

* Address PR feedback

* Make contact support a mailto link

* Add --log-level flag to `influxd upgrade`

Closes #1795

* add release note about api/v2/delete

* update delete data note for 2.0

* edit

* Fix URLs and filenames in OSS 2.0 Get Started

* update version for GA

* Add color to Flux example for Flux documentation (addresses #1724 )

* Change versions to 2.0.1 in GS

* Replace 2.0.0 with 2.0.1

* Revert Docker updates to 2.0.0

* Add release notes for 2.0.0

* edits; add known issue

* clarify DB is 1.x

* updated influxdb versions in cloud and oss getting started

* updated influxdb oss urls doc

* remove rc and upd upgrade link in back up data

* Edit `influxd upgrade` docs (#1798)

* Edit `influxd upgrade` guide

Major revision of existing docs.

Add "Before you begin: important considerations" section.

* Address PR feedback

* Edit backup instructions

* More work on kap

* Rm comment

* Rm sentence

* Add note on Docker

* Edit intro

* Edit link

* Work on PR feedback

* Continue PR feedback

* More PR feedback

* More edits

* more edits

* Edits

* more edits

* rm word

* updates to address PR feedback for the upgrade guide

Co-authored-by: pierwill <pierwill@users.noreply.github.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>

Co-authored-by: Kelly <kelly@influxdata.com>
Co-authored-by: pierwill <pierwill@users.noreply.github.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com>
2020-11-11 09:52:14 -07:00
Scott Anderson 5b9783c055
New support and feedback layout (#1423)
* WIP new feedback/support block

* restructured and restyled support and feedback section

* added api issue button to swagger-generated api docs, resolves #1415

* added community slack link, restyled ul for feedback block

* minor wording change in feedback section
2020-09-09 21:49:06 -06:00
Scott Anderson c05aa7187c restyled landing page colors, added brand gradients 2020-04-21 11:47:39 -06:00
Scott Anderson 9eec3e1729 WIP api-docs autogen, stylesheets, and auto-build process 2019-09-30 10:00:22 -06:00
Scott Anderson 0b6db10137 WIP swagger-generated API docs 2019-09-27 14:42:01 -06:00