Commit Graph

9 Commits (cli2.4-release-notes)

Author SHA1 Message Date
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
Jason Stirnaman df14f93735
fix: cloud 1.x compat docs link to oss 2.0 pages. Dedupe content. Use… (#3511)
* fix: cloud 1.x compat docs link to oss 2.0 pages. Dedupe content. Use consistent placeholders and placeholder instructions. Remove redundant shortcode. (closes #3477)

* fix: placeholders in 2.0 1.x query.

* fix: cloud example user email address (#3477).

* Update content/influxdb/v2.1/reference/api/influxdb-1x/_index.md

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

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-12-21 09:16:41 -06:00
Jason Stirnaman 22cf8ccadc
API examples and client guide updates (#3106)
* feat: troubleshoot write errors (#3003). Fix link in Flux reference.

* fix: make placeholders consistent and conform to style guide.

* fix: Node.js client. Delete unused files (#3003)

* Node.js client. Add examples.

* fix: gzip instructions for API with curl.

* fix: Node.js client guide. Query guide fixes. Frontmatter fixes.

* fix: API client frontmatter consistency. Use language for title so <children> list is sorted properly.

* Update content/influxdb/v2.0/api-guide/client-libraries/nodejs/install.md

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

* Update content/influxdb/v2.0/api-guide/client-libraries/nodejs/write.md

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

* Update content/influxdb/v2.0/api-guide/client-libraries/nodejs/write.md

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

* Update content/influxdb/v2.0/api-guide/client-libraries/nodejs/query.md

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

* fix: customize example URLs (closes #3113)

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-09-13 11:08:02 -05:00
Jason Stirnaman e8666ddc22
2696 api browserjs fixes (#3005)
* fix: broken link (#2696).

* fix: correct errors in javascript for browsers. Added token warning. (#2696)

* WIP - split Javascript guide into separate pages.

* WIP - Revised and split JavaScript browser

* WIP fix: errors in browser and node js client library.

* fix: simplify and correct JavaScript for browsers. Remove separate library entry. Assume users will prefer ESM. Simplify instructions for the browser example app.

* fix: add import instruction

* fix: Redo Javascript browser doc. Break down the use cases and improve examples.

* fix: browser use cases for JS module distributions.

* fix: browser package should be used whether bundling or not.
2021-08-16 16:26:29 -05:00
Jason Stirnaman 39e775be62 Merge branch 'master' of github.com:influxdata/docs-v2 into feature/2689-get-started-with-api
* 'master' of github.com:influxdata/docs-v2: (63 commits)
  CLI fixes (#2844)
  Fix links (#2828)
  Fix/2759 1.x query api (#2841)
  fix: updating windows start instructions (#2842)
  Add static legend to visualization examples (#2837)
  Fix Windows CLI download link (#2840)
  Fix incorrect Telegraf output settings info (#2754)
  Move static legend to cloud-only (#2798)
  ThingWorx integration (#2558)
  edits
  Update content/influxdb/v2.0/process-data/task-options.md
  Update content/influxdb/v2.0/process-data/task-options.md
  Update task-options.md
  hr eg covers itt
  1.19.1 release notes (#2819)
  edit
  fixes issue #2672 https://github.com/influxdata/docs-v2/issues/2672
  Update content/kapacitor/v1.6/guides/anomaly_detection.md
  Update content/kapacitor/v1.5/guides/anomaly_detection.md
  Update content/kapacitor/v1.4/guides/anomaly_detection.md
  ...
2021-07-15 13:50:48 -05:00
Jason Stirnaman 9bb3340b02
Fix/2759 1.x query api (#2841)
* fix: 1.x compat api. Clarify authentication schemes, parameters, and use cases for OSS and Cloud (#2759)

* fix: curl examples

* update: add node.js examples

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-07-14 16:59:39 -05:00
Jason Stirnaman e8c9039ce1 update: restructured nodejs install and write guide. 2021-06-15 15:33:08 -05:00
Jason Stirnaman 5669ab17a3 update: divided JS client library page into separate.
* reorganized api shortcodes
2021-06-14 10:27:23 -05:00
Jason Stirnaman c03f70fa3c update: api client libs
* update: added api-guide and moved client libs there (#2689)
* extracted code examples to separate shortcode files (#2689)
2021-06-11 09:34:36 -05:00