Commit Graph

13 Commits (master)

Author SHA1 Message Date
Jason Stirnaman 37a7a7c6e7 chore(ci): Improve pre-commit hook, test harness, and linter
- Pre-commit hook:
       - Redo test harness so commands can run in parallel
       - Cleanup Vale command args
       - Replace lint-staged and husky with Lefthook.
    - Pre-push hook:
       - Scan for package vulnerabilities
    - Tests
      - Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc.
      - Each test container (service) runs the prepare-content script before running tests.
      - Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect.
      - Bind mount influxctl config.toml and .env.test files
      - Bind mount scripts for faster builds while iterating on test scripts.
    - Vale:
      - Override Acronyms style def--ignore acronym if it's linked.
2024-07-23 15:08:28 -05:00
Jason Stirnaman 5c74f013a1 chore(ci): Improve CI lint and test runners
- Reconfigures prettier linting.
- Adds .editorconfig to help with consistent editor settings
- Refactors test runs:
  - Removes test configuration from compose.yaml (not suited for this use case).
  - Splits test runner into test content setup and pytest that can be run separately or together (and with other test runners in the future).
  - Configuration is in Dockerfiles and command line (`.lintstagedrc.mjs`)
- Updates CONTRIBUTING.md
- Updates client library write examples in cloud-dedicated and clustered.
2024-06-21 18:41:07 -05:00
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 9e33fe690a
Jts/api guides (#3862)
* - Add tutorial that guides a developer through building a simplified IoT
  center app with client libraries.
- device registration and authorization.
- write and query--explain batch writes with the JS client library.

* - feat: queries and visualizations with Giraffe library. queryToTable, Giraffe table.

* feat(api-guide): revise intro, auth, example headings.

* feat(api-guide): describe resources. describe auth and API tokens.

- API basics

* fix: influxdb and iot center setup

* fix: update registration steps to include the new INFLUX_BUCKET_AUTH flow.

* feat(api-guides): Add client library example to fetch routes.

- install, links.
- replace use of getIoTAuthorizations with query from getDevices.
- breakdown create device API requests.
- initial commit of API guide using Next.js with Influx client libraries. Project source at https://github.com/jstirnaman/nextjs-iot-starter.
- explain the flow to register a device. Remove unused example code. TODO: document the setup and UI.
- Add UI code samples. Revise headings. Explain API purpose.
- UI component fixes and refactor. Input field takes a device ID, queries, and re-renders the list with results. Registration button submits device ID for a new authorization.

* feat(api-guide): add iot-starter guide index page, fix errors

- add the iot-starter directory and index page
- fix tag errors and links.

* feat: IoT starter navigation.

* feat(api-guide): nav and intros.

* wip: rearrange, move full examples to top of section and link to explainers.

* chore: Shared intro shortcode for iot-starter tutorials.

* fix: intros, navigation, and config instruction

- Add intro shortcode for tutorials to share.
- Organize navigation for language-specific tutorials (would prefer to unify as much as possible).
- Update environment variable config instruction.

* Feature/api guide python client (#4023)

* adding placeholders into code

* create_device not tested yet

* everything working except flux query and filter query

* fix: replace download button with spec link. (#4013)

- Closes #3810 - Remove download button and add a link to the spec source in Github.

* Enterprise 1.9.7 release notes (#4007)

* added not under flux updates

* updates based on feedback

* changed release notes date

* added requested update

* added detail about script builder (#3995)

* added detail about script builder

* Update content/chronograf/v1.9/guides/querying-data.md

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

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

* fix: async writes and deletes (#4015)

- Correct handling of writes and deletes in cloud vs. oss (async vs. sync).
- Cleanup redundancy in Troubleshooting.
- Closes https://github.com/influxdata/DAR/issues/291

Co-authored-by: lwandzura <51929958+lwandzura@users.noreply.github.com>

* Collect user feedback per page and restructure modals (#4014)

* WIP feedback forms

* WIP complete feedback lifecycles

* finalize page feedback interactions

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

* Revert "Enterprise 1.9.7 release notes (#4007)" (#4017)

This reverts commit c6f4a99d72.

* hotfix: fix cli homebrew package name, closes #4022

* docs: add python iot guide

* fix: remove .idea files

* fix: remove .idea files and package-lock

* fix: initial batch of fixes

* fix: finished PR changes

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

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

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

* Update content/influxdb/v2.2/api-guide/iot-starter/_index.md

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

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

* Update content/influxdb/v2.2/api-guide/iot-starter/python.md

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

* Update content/influxdb/v2.2/api-guide/iot-starter/_index.md

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

* Update content/influxdb/v2.2/api-guide/iot-starter/_index.md

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

* Update content/influxdb/v2.2/api-guide/iot-starter/_index.md

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

* Delete _index.md

Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MacBook-Pro.local>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: lwandzura <51929958+lwandzura@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: Scott Anderson <scott@influxdata.com>
Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MBP.lan>

* chore: replace UI code with GH links, fix navigation.

* feat: API client library tutorials

- Cleanup py and js tutorials.
- JS is still WIP.
- Fix nav.

* fix: Revise Node.js tutorial.

* fix: Revise Python tutorial.

* fix: Remove last bullet since Node.js tutorial isn't that far yet.

* Update content/influxdb/v2.2/api-guide/tutorials/client-library-starter/_index.md

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

* Update content/influxdb/v2.2/api-guide/tutorials/client-library-starter/nodejs.md

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

* wip: Install and run the UI.

* docs: fix instructions and move UI docs to iot-api-ui README.

* fix: Update JS and Py tutorials with common UI.

* fix: Update code samples in nodejs and python IoT starter tutorials.

* fix: fixup.

* fix: Cleanup code tabs.

* fix: update toc

* fix: iot-starter

Fix examples.
Cleanup.

* fix: python restart

* fix: Cleanup.

* chore: add repo links

* Add cloud, fix frontmatter.

* fix: Remove links to sections.

Co-authored-by: sunbryely-influxdata <101659702+sunbryely-influxdata@users.noreply.github.com>
Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MacBook-Pro.local>
Co-authored-by: lwandzura <51929958+lwandzura@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: Scott Anderson <scott@influxdata.com>
Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MBP.lan>
2022-06-15 19:15:46 -05:00
Scott Anderson b0e81bb979
Restructured cloud org and user management (#3461)
* WIP remove user refresh

* restructured cloud user management docs, closes influxdata/DAR#257

* Apply suggestions from code review

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

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-12-13 09:22:29 -07:00
Scott Anderson ddd1449551 hotfix: added .hugo_build.lock to .gitignore 2021-11-18 13:05:16 -07:00
Jason Stirnaman 6587ee1fdc
Document new API Invocable Scripts feature (was named-functions) (#3282)
* feat: add api-guides/guides and guides/api-invocable-scripts for the API-invocable scripts (managed functions) feature (##2547, #2233).

* feat: document API-invocable scripts. Add example for creating and invoking a script with POST. Unable to make GET work with query parameters.

* feat: moved API-invocable scripts under api-guide. Remove guides directory. Add docs for list and find. Add example for list. Add shortcuts and glossary links. Verified with team-compute that GET /invoke and python are not supported yet.

* feat: rename example function for simplicity since there's no GET for now.

* feat: add find_and_update example (#2547).

* feat: add update example. Clarify, expand invoke example. Add links. (#2547)

* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md

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

* fix: remove accidental commit of generated redoc-static.html

* feat: manual update to cloud swagger. Merges meta, auth, tags, and x-tagGroups from src/cloud.yml to aggregate contracts/ref/cloud.yml.

* fix: replace /functions with /scripts

* feat: get swaggers from contracts/ref. Still requires copy-paste of info, tags, and auth from contracts/cloud.yml and contracts/oss.yml

* feat: invocable scripts (#2547)

* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* feat: new section for params (#2547).

* fix: swagger server url (#2547)

* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md

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

* feat: remove jq and function where there's no clear need.

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2021-10-25 08:30:31 -05:00
Jason Stirnaman 80acfc79fd add: Develop with the API.
* Copied API intro and clients docs to /api.
* Added bootstrapping info.
2021-06-09 17:35:07 -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 9eec3e1729 WIP api-docs autogen, stylesheets, and auto-build process 2019-09-30 10:00:22 -06:00
Gunnar Aasen b2227eeb74 Initial cloudformation template to deploy docs 2019-01-17 13:59:44 -08:00
Scott Anderson cd22dcc1e6 established asset pipeline 2018-12-19 14:36:12 -07:00
Scott Anderson 8a7093663d added .gitignore 2018-12-13 11:48:25 -07:00