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.

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

[Docs RFC]: writing test for Anagha. #3688

Closed
billy-the-fish opened this issue Jan 6, 2025 · 0 comments · Fixed by #3689
Closed

[Docs RFC]: writing test for Anagha. #3688

billy-the-fish opened this issue Jan 6, 2025 · 0 comments · Fixed by #3689
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@billy-the-fish
Copy link
Contributor

billy-the-fish commented Jan 6, 2025

Fully test the page that shows how to integrate Apache Airflow with Timescale Cloud.

The end result must be:

  • Technically correct: end users must be able to easily and successfully follow the step-by-step procedure
  • Correctly formatted: the Markdown in the page must be correctly rendered in the doc output. Clue, currently the Markdown does not render correctly. Check the indenting.
  • Follow the Google Developer style guide: this page already follows the style guide. Any updates must be consistent.
  • Use variables for name wherever possible: https://docs.timescale.com/variables-for-contributors/.
  • Another Clue, although this page often says TimescaleDB, you are writing this for Timescale Cloud service. You can get around this using variables :-).
  • Another Clue. The info from the notes should be in the prerequisites

Create a free Timescale Cloud service to test these docs. You find the instructions on how to do this in the prerequisites in the page you are updating.

@billy-the-fish billy-the-fish added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 6, 2025
@billy-the-fish billy-the-fish linked a pull request Jan 6, 2025 that will close this issue
@billy-the-fish billy-the-fish changed the title [Docs RFC]: writing test for Anaga. [Docs RFC]: writing test for Anagha. Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant