Skip to content

Conversation

@lzdanski
Copy link
Contributor


After making a couple of my own docs PR's and helping some colleagues work with Sphinx, wanted to add some more detailed information to the Docs Readme that have commonly come up.

  • Adds link to Docs Readme from main Contributing Guide.
  • Copyediting of existing Readme content.
  • Adds information about the workflow for making docs changes, recommendations about where to edit for particular kinds of docs changes (local vs in GitHub), and explains how to use local builds for QC testing.
  • Describes where and how to find the source content for updating docs, since some content is autogenerated from strings in Python files.
  • Add information about the Docs CI/CD tests that must pass before merging and how to run them locally before submitting a PR.
  • Adds a troubleshooting section to the readme that documents the common error UNEXPECTED UNINDENT and resolution as well as the existing Sphinx bug that reports the incorrect line number.

Other considerations:

  • Is there a standard number of characters in each line we'd like Docs to use or when to include line breaks? It looks like we all use somewhat different line lengths.

docs/README.rst Outdated
Copy link
Member

Choose a reason for hiding this comment

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

In the new version of build-docs (since ~ 3 months) you can simply specify package names as arguments without --package-filter - they are also autocomplete'able.

docs/README.rst Outdated
Copy link
Member

Choose a reason for hiding this comment

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

You can add empty __init__.py and pre-commit should add the licence automatically as well.

Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

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

Very nice! Thanks. There are a few NITs, and clarifications but it's great to see more guidelines for the contributors.

Copy link
Contributor

@josh-fell josh-fell left a comment

Choose a reason for hiding this comment

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

This is tremendous! Only one question/suggestion.

@potiuk
Copy link
Member

potiuk commented Dec 22, 2023

static checks :)

@lzdanski lzdanski force-pushed the update-docs-contributing-docs branch from 5c2fb5e to e54b887 Compare December 22, 2023 21:08
Copy link
Contributor

@josh-fell josh-fell left a comment

Choose a reason for hiding this comment

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

🚀

@potiuk potiuk merged commit 690d6e2 into apache:main Dec 22, 2023
@ephraimbuddy ephraimbuddy added this to the Airflow 2.8.2 milestone Feb 19, 2024
@ephraimbuddy ephraimbuddy added the type:doc-only Changelog: Doc Only label Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants