Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: write-data sections and code samples #5503

Merged
merged 11 commits into from
Jun 26, 2024
Merged

fix: write-data sections and code samples #5503

merged 11 commits into from
Jun 26, 2024

Conversation

jstirnaman
Copy link
Contributor

@jstirnaman jstirnaman commented Jun 25, 2024 •
edited
Loading

Closes #5475 for v3 python write_options

  • Updates /write-data/ sections
    • makes cloud-serverless consistent with dedicated and clustered
    • Updates dedicated and clustered nomenclature (measurements -> tables, buckets -> databases)
  • Fixes get-started code blocks, formats curl response for tests
  • Improves test runners
    • You'll need to move your docs-v2/.env.<product> test credentials config to docs-v2/content/influxdb/<product>/.env.test
    • Refactors test content into a separate container and volume for future test runners (e.g. JavaScript) to use
    • Doesn't fail if no tests (code blocks) exist in the staged files.

Describe your proposed changes here.

@jstirnaman
fix: reference: python v3 client library examples should use write_op…
37dd3ea 
…tions, not WriteOptions

Fixes #5475
@jstirnaman
chore(ci): Improve CI lint and test runners
5c74f01 
- 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.
@jstirnaman
chore: fix formatting
3274742
@jstirnaman
chore: Write data improvements
17c4315 
-  Format and structure serverless write-data
- Structure cloud-serverless write-data/line-protocol the same as clustered and dedicated to allow for adding more tool-specific pages.
- Make influxctl examples pass tests
@jstirnaman
fix: whitespace
e0097c9
@jstirnaman
chore: Remove prettier from Markdown linting--to many whitespace conf…
3bde906 
…licts with code blocks
@jstirnaman
fix: bad link
cc0a4de
@jstirnaman
fix: add serverless alt-links for influxctl
bb166b0
@jstirnaman
fix: lint-staged test runner to not fail if no tests are collected, u…
f9bd089 
…pdate CONTRIBUTING.md instructions for test credentials
@jstirnaman
fix: write-data section: consistent page titles, database and table n…
9d542dd 
…omenclature in dedicated and clustered
@telegraf-tiger telegraf-tiger bot added the fix label Jun 25, 2024
sanderson
sanderson approved these changes Jun 25, 2024
View reviewed changes
Copy link
Collaborator

@sanderson sanderson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jstirnaman jstirnaman merged commit 26eb724 into master Jun 26, 2024
2 checks passed
@jstirnaman jstirnaman deleted the jstirnaman/issue5475 branch June 26, 2024 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sanderson sanderson sanderson approved these changes

Assignees
No one assigned
Labels
fix
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

python v3 client library examples should use write_options, not WriteOptions
2 participants
@jstirnaman @sanderson