mik-laj commented on a change in pull request #13767:
URL: https://github.com/apache/airflow/pull/13767#discussion_r560629925
##########
File path: dev/provider_packages/PROVIDER_INDEX_TEMPLATE.rst.jinja2
##########
@@ -0,0 +1,84 @@
+{#
+ 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.
+
+ NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE
+ OVERWRITTEN WHEN PREPARING PACKAGES.
+
+ IF YOU WANT TO MODIFY IT, YOU SHOULD MODIFY THE TEMPLATE
+ `PROVIDER_INDEX_TEMPLATE.rst.jinja2` IN the `provider_packages` DIRECTORY
+
+#}
+
+Package {{ PACKAGE_PIP_NAME }}
+------------------------------------------------------
+
+Release: {{ RELEASE }}{{ VERSION_SUFFIX }}
+
+Provider package
+----------------
+
+This is a provider package for ``{{PROVIDER_PACKAGE_ID}}`` provider. All
classes for this provider package
+are in ``{{FULL_PACKAGE_NAME}}`` python package.
+
+Installation
+------------
+
+.. note::
+
+ On November 2020, new version of PIP (20.3) has been released with a new,
2020 resolver. This resolver
+ does not yet work with Apache Airflow and might lead to errors in
installation - depends on your choice
+ of extras. In order to install Airflow you need to either downgrade pip to
version 20.2.4
+ ``pip install --upgrade pip==20.2.4`` or, in case you use Pip 20.3, you
need to add option
+ ``--use-deprecated legacy-resolver`` to your pip install command.
+
+
+You can install this package on top of an existing airflow 2.* installation via
+``pip install {{PACKAGE_PIP_NAME}}``
+{%- if PIP_REQUIREMENTS %}
+
+PIP requirements
+----------------
+
+{{ PIP_REQUIREMENTS_TABLE_RST | safe}}
+{%- endif %}
+{%- if CROSS_PROVIDERS_DEPENDENCIES %}
+
+Cross provider package dependencies
+-----------------------------------
+
+Those are dependencies that might be needed in order to use all the features
of the package.
+You need to install the specified backport providers package in order to use
them.
+
+You can install such cross-provider dependencies when installing from PyPI.
For example:
+
+.. code-block:: bash
+
+ pip install {{ PACKAGE_PIP_NAME }}[{{ CROSS_PROVIDERS_DEPENDENCIES[0] }}]
+
+
+{{ CROSS_PROVIDERS_DEPENDENCIES_TABLE_RST | safe }}
+
+{%- endif %}
Review comment:
In my opinion, this page has too much content and some are missing (but
the missing ones do not need to be added now). I like the README files. which
is available in the documentation of Google libraries.
https://googleapis.dev/python/firestore/latest/index.html
It is standardized too, but contains all the information you need.
1. Starting at the top. So I think it's worth adding a description of the
package itself. This information is available in the `provider.yaml` file,
although so far the descriptions are not very. precise.h
ttps://github.com/apache/airflow/blob/1602ec97c8d5bc7a7a8b42e850ac6c7a7030e47d/airflow/provider.yaml.schema.json#L13-L16
I hope that we will be able to prepare descriptions in the future gradually,
but so far I have made a minimum step and added a link to the product page for
each provider.
2. The next step is to link to the documentation, if we want to use the same
file in setup.py and in the documentation. This will make it easier to find the
documentation when you are in pypi.
We have these links in the side menu, but this is quite a new feature and
not everyone uses this menu. Especially on mobile devices, I start reading from
the package description, not the side menu.
3. The division into a detailed changelog and a normal changelog is strange
for me. As for me, the contents of the ADDITIONAL_INFO.rst file should be a
normal documentation page and have the title "Migration guide" because this is
exactly what this file contains. As this file is fully human written, I don't
think other scripts need to process it as well.
4. I think the detailed changelog and migration guides worth moving to new
subpages, because it is not important for the new user. This then will look
similar to the Google documentation
.
When we move the guides to new pages, we will also be able to easily prepare
the migration guide from Airflow 1.10, because we already have a table that
facilitates these migrations.
![Uploading Screenshot 2021-01-20 at 03.21.33.png…]()
5. The links in the table use markdown syntax instead of rst.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
