Commit Graph

40 Commits (fix-api-ref-paths)

Author SHA1 Message Date
Jason Stirnaman 7462c7e3e8 fix(v1,v2): bad aliases causing 404s
- Cleanup use of alias singular
- Fix lint error
Closes #5632
2024-10-03 16:18:34 -05:00
Jason Stirnaman ed0586cd13 fix(v2): API nav items:
- Fixes sidebar navigation for API pages, moving the v1-compatibility Hugo page into Develop with the API.
- Makes titles consistent for API reference docs.
- Disables linkify autolinking of URLs and email addresses to prevent autolinking example email addresses (I audited content to make sure we don't rely on the autolinking behavior; we use explicit HTML/MD syntax for links)
- Uses standard placeholders and adds test setup for v1-compat write and query.
- Clean up Markdown
- Adds home-sensor-data.lp to Downloads (thought it was already there)
2024-09-18 10:18:17 -05:00
Scott Anderson 636f5ada45
V2 nav reorg (#5213)
* nest reference docs menu in v2 and cloud

* move migrate data into write data

* nest notebooks under tools

* nest templates under tools

* nest telegraf configs under tools

* cleanup weights and titles of tools sections

* reorg org and bucket management under admin

* add backup/restore to admin, clean up related links

* restructure security sections under admin

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* updated serverless cli docs to address pr feedback

* Update content/influxdb/cloud/admin/organizations/delete-org.md

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* port v2 install changes to new structure

* address pr feedback and ported missing content to serverless

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-11-06 15:53:12 -07:00
Scott Anderson 35ad46c4c2
Version restructure (#5133)
* mass changes for version restructure

* fixed latest-patch and flux version generator

* updated hugo configs

* fixed flux frontmatter injector

* fixed flux frontmatter injector

* WIP api generator updates for version restructure (#5128)

* fixed telegraf plugin list

* removed latest shortcode

* fixed current-version

* fixed product dropdown crosslinking

* fixed alt links

* WIP fixing links

* fixed broken links

* updated api doc generation

* fixed additional resources

* added version redirects to edge.js

* fixed search placeholder

* fixed paged titles
2023-09-12 23:33:31 -06:00
Scott Anderson 8adade5927
updated api-endpoint shortcodes with api-refs and new styles (#4834) 2023-03-28 12:44:52 -06:00
Jason Stirnaman 6aad82f4d1
4806 document different ways to execute queries against iox (#4820)
* fix(cloud-iox): typo.

* fix(cloud-iox): typo

* fix(iox): revise DATE_BIN example and link to reference.

* feat(iox): execute queries and visualize data with SQL in IOx.

* feat(cloud-iox): execute queries with Data Explorer (#4806).

- Publish steps for Execute Queries with Data Explorer.
- Remove pages not ready for IOx.
- Fix links in Get Started.
- Fix tags.

* feat(iox): Add API to IOx Reference, consolidate Cloud and OSS pages (#4788).

* fix(cloud-iox): IOx Data Explorer and Flux links.

* fix(cloud-iox): 1.x API menu.

* fix(cloud-iox): remove visualization types until we've verified links, etc.

* fix(cloud-iox): delete additional 1.x reference docs for now, revise Data Explorer.

* fix(api): replace cloud with cloud-iox in URLs, remove errant externalDocs link.

* feat(cloud-iox): add admin/accounts with data-usage and limits pages.

* fix(cloud): revise and remove outdated info from account management.

* fix(iox): punctuation.

* fix(cloud-iox): update link paths.

* fix(cloud-iox): update link paths for cloud-iox.

* patch(cloud-iox): quick fix for v1compat link paths
2023-03-21 16:34:13 -05:00
Sunbrye Ly c57cba0527 fix: bump client library tutorials up one level 2022-08-23 12:18:30 -07:00
Sunbrye Ly cf8eeca143 fix: not working on cloud yet... 2022-08-19 18:15:17 -07:00
sunbryely-influxdata 50a3eb1d99
Merge branch 'master' into fix/iot-starter-page 2022-06-16 14:01:33 -07:00
Sunbrye Ly 0a118d5f5f fix: fix children 2022-06-16 13:57:50 -07:00
Jason Stirnaman 4e7acc1385 hotfix: JS tutorial list title. 2022-06-15 19:44:49 -05: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
peterreg eb34c798dd
Adding InfluxDB University course links to relevant areas in docs (#4102)
* Adding InfluxDB University videos to various docs.

* Update content/enterprise_influxdb/v1.9/introduction/installation/_index.md

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

* Add edits from kelseiv

* Adding edit from Scott

Thanks!

Co-authored-by: peterreg <pregan@influxdata.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2022-06-08 17:07:27 -07:00
lwandzura 39ade37dc2
Fix kotlin page (#4062)
* updated Kotlin page for OSS and cloud

* added desc and button to client libs in github

* Update content/influxdb/v2.2/api-guide/client-libraries/ruby.md

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

* Update content/influxdb/v2.2/api-guide/client-libraries/java.md

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

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2022-05-24 11:50:58 -05:00
Scott Anderson fed1488e7d fix menu items with external URLs, closes #3797 2022-02-22 10:00:03 -07:00
rydermeehan 7e91019226
Update go.md (#3574) 2022-01-18 11:14:34 -08:00
rydermeehan 6610e94fb9
Update browserjs.md (#3580)
* Update browserjs.md
2022-01-18 10:40:10 -08:00
Scott Anderson 3ffa3c6c23
add dart client library (#3652) 2022-01-11 16:58:30 -07:00
Scott Anderson f679b8886b
udpate node.js tag to nodejs (#3648) 2022-01-10 11:45:49 -07:00
kelseiv 5ffaff1c67
invokable (#3405)
* invokable

* update filename and add alias

* fix: rename samples to api-invokable-scripts

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2021-11-16 12:05:07 -08:00
Scott Anderson c8c4af72be
Update process flows for monitor and alert section (#3372)
* update process flows for monitor and alert

* Apply suggestions from code review

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

* minor update to address PR feedback

* updated monitor and alert sections in cloud, updated for PR feedback

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2021-11-10 17:04:24 -07:00
Jason Stirnaman f9ce94d29a
Chore/jts update process clockface (#3387)
* fix: typo.

* fix: clean up auth instructions in Postman.

* fix: Postman test instruction

* fix: typo

* fix: API example for thingworx.

* fix: updates for clockface. Typo fixes. (#3374)

* fix: query sample data typos

* Update content/influxdb/cloud/query-data/execute-queries/query-sample-data.md

* Update content/influxdb/cloud/get-started.md

* Update content/influxdb/cloud/query-data/execute-queries/query-demo-data.md

* Update content/influxdb/cloud/tools/thingworx.md

* Update content/influxdb/v2.0/api-guide/postman.md

* Update content/influxdb/v2.1/query-data/execute-queries/query-sample-data.md

* Update content/influxdb/v2.1/query-data/execute-queries/data-explorer.md

* Update content/influxdb/v2.1/api-guide/postman.md

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

* Update content/influxdb/v2.0/api-guide/postman.md

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

* Update content/influxdb/v2.1/api-guide/postman.md

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

* Update content/influxdb/v2.1/api-guide/postman.md

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

* Update content/influxdb/v2.1/api-guide/postman.md

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

* Update content/influxdb/v2.0/api-guide/postman.md

* Update content/influxdb/v2.1/api-guide/postman.md

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

* Update content/influxdb/v2.1/api-guide/postman.md

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

* Update content/influxdb/cloud/api-guide/postman.md

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

* Update content/influxdb/cloud/get-started.md

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

* Update content/influxdb/cloud/get-started.md

* Update content/influxdb/cloud/visualize-data/explore-metrics.md

* Update content/influxdb/v2.0/api-guide/postman.md

* Update content/influxdb/v2.1/api-guide/postman.md

* Update content/influxdb/cloud/query-data/execute-queries/query-sample-data.md

* fix: code typo.

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-11-10 10:54:18 -06:00
Jason Stirnaman 6ee3d25d87
3240 fix nodejs alias (#3317)
* fix: mjs example path (#3305)

* fix: add alias to node.js client library (#3240)
2021-10-28 09:15:20 -05:00
Jason Stirnaman ba3f0385ea
Fix api invocable (#3310)
* fix: measurement -> point

* fix: cloud API ref. Remove private paths. Patch description and orgID params into ScriptCreateRequest.
2021-10-26 10:55:24 -05:00
Jason Stirnaman b7dc129e48
fix: endpoint text. (#3308) 2021-10-26 09:10:57 -05:00
Jason Stirnaman a6254e1e79
Fix api invocable (#3306)
* fix: scripts api path.

* fix: bad comma

* feat: add invocable scripts example for sending multiple parameter values.
2021-10-26 08:48:08 -05:00
Jason Stirnaman 08ff528161
Fix api invocable (#3299)
* fix: scripts api path.

* fix: bad comma
2021-10-25 14:14:08 -05: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 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 0635eaf749
fix: add alias for old python URL (#1722) (#3011) 2021-08-11 15:56:09 -05:00
alespour 854b1e9151
Merge pull request #2872 from bonitoo-io/feat/add-r-client-library-ref
docs: add R client library reference
2021-07-22 11:21:08 +02:00
Scott Anderson d78aa0b7b0 hotfix: add alias for client libs 2021-07-20 15:42:31 -06:00
Scott Anderson 6a153a2d2b hotfix: fix client libraries links 2021-07-20 10:02:24 -06:00
Ales Pour 1ef28a01de docs: add R client library reference 2021-07-20 15:18:06 +02:00
Jason Stirnaman b39bf036e0
fixes API guide changes, create-bucket, aliases (#2860)
* fix: fix broken link by adding API guide for creating a bucket.  - add example code.  - add aliases for pages moved from Tools.
* fix: move create a bucket into the existing page for now. Copy example to API quick start.

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-07-16 16:23:21 -05:00
Scott Anderson 153f078baa
clean up some frontmatter (#2857) 2021-07-15 16:49:39 -06:00
Jason Stirnaman e8c9039ce1 update: restructured nodejs install and write guide. 2021-06-15 15:33:08 -05:00
Jason Stirnaman b43dbe5994 update: wip: client apis * reorg client files * added postman auth note. * starting redo for Node.js 2021-06-11 17:35:04 -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