lzdanski opened a new pull request, #36287:
URL: https://github.com/apache/airflow/pull/36287
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
---
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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
