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

Slim down generated provider's READMEs #13274

Closed
potiuk opened this issue Dec 23, 2020 · 2 comments
Closed

Slim down generated provider's READMEs #13274

potiuk opened this issue Dec 23, 2020 · 2 comments
Assignees
@potiuk
Labels
AIP-8 - Provider packages
Milestone
apache-airflow-pr...

Comments

@potiuk
Copy link
Member

potiuk commented Dec 23, 2020

The generated READMES should contain only ADDITIONAL_INFO.md and Brief description of the package, link to the detailed documentation and list of changes since the last release.
@potiuk potiuk self-assigned this Dec 23, 2020
@potiuk potiuk mentioned this issue Dec 23, 2020
Closed
9 tasks
@debodirno
Copy link
Contributor

I can work on this @potiuk. Please assign it to me?

@potiuk
Copy link
Member Author

potiuk commented Jan 4, 2021

Same here. This is part of the change on how provider packages are generated, that's why I had it assigned to myself and I am quite close to complete it.

@potiuk potiuk mentioned this issue Jan 19, 2021
Merged
potiuk added a commit to higrys/airflow that referenced this issue Jan 24, 2021
@potiuk
Implement target provider versioning tools
712d06f 
This change implements per-provider versioning tools. Version of the
providers is retrieved from provider.yaml file (top-level verion).
Documentation is generated in the documentation folder rather than
in sources and embedded in provider's index. Backport providers
remain as they were until we delete all the backport references in
April 2021 nd then the code can be simplified and the
backport functionality can be removed then.

When generating multiple providers, only those that have version
that has no corresponding `providers-<PROVIDER>/<VERSION>` are
generated. Other providers are skipped with warnings.

Fixes: apache#13272, apache#13271, apache#13274, apache#13276, apache#13277, apache#13275, apache#13273
potiuk added a commit to PolideaInternal/airflow that referenced this issue Feb 1, 2021
@potiuk
Implement provider versioning tools
84eddbc 
This change implements per-provider versioning tools. Version of the
providers is retrieved from provider.yaml file (top-level verion).
Documentation is generated in the documentation folder rather than
in sources and embedded in provider's index. Backport providers
remain as they were until we delete all the backport references in
April 2021 nd then the code can be simplified and the
backport functionality can be removed then.

When generating multiple providers, only those that have version
that has no corresponding `providers-<PROVIDER>/<VERSION>` are
generated. Other providers are skipped with warnings.

Old documentation is removed and new CHANGELOG.rst have been
prepared for all providers to accomodate to the new process
(which is comming as a follow-up commit)

Fixes: apache#13272, apache#13271, apache#13274, apache#13276, apache#13277, apache#13275, apache#13273
potiuk added a commit that referenced this issue Feb 1, 2021
@potiuk
Implement provider versioning tools (#13767)
ac2f72c 
This change implements per-provider versioning tools. Version of the
providers is retrieved from provider.yaml file (top-level verion).
Documentation is generated in the documentation folder rather than
in sources and embedded in provider's index. Backport providers
remain as they were until we delete all the backport references in
April 2021 nd then the code can be simplified and the
backport functionality can be removed then.

When generating multiple providers, only those that have version
that has no corresponding `providers-<PROVIDER>/<VERSION>` are
generated. Other providers are skipped with warnings.

Old documentation is removed and new CHANGELOG.rst have been
prepared for all providers to accomodate to the new process
(which is comming as a follow-up commit)

Fixes: #13272, #13271, #13274, #13276, #13277, #13275, #13273
@potiuk potiuk closed this as completed Feb 4, 2021
potiuk added a commit that referenced this issue Mar 3, 2021
@potiuk
Implement provider versioning tools (#13767)
99d1e18 
This change implements per-provider versioning tools. Version of the
providers is retrieved from provider.yaml file (top-level verion).
Documentation is generated in the documentation folder rather than
in sources and embedded in provider's index. Backport providers
remain as they were until we delete all the backport references in
April 2021 nd then the code can be simplified and the
backport functionality can be removed then.

When generating multiple providers, only those that have version
that has no corresponding `providers-<PROVIDER>/<VERSION>` are
generated. Other providers are skipped with warnings.

Old documentation is removed and new CHANGELOG.rst have been
prepared for all providers to accomodate to the new process
(which is comming as a follow-up commit)

Fixes: #13272, #13271, #13274, #13276, #13277, #13275, #13273
(cherry picked from commit ac2f72c)
potiuk added a commit that referenced this issue Mar 3, 2021
@potiuk
Implement provider versioning tools (#13767)
5896cd0 
This change implements per-provider versioning tools. Version of the
providers is retrieved from provider.yaml file (top-level verion).
Documentation is generated in the documentation folder rather than
in sources and embedded in provider's index. Backport providers
remain as they were until we delete all the backport references in
April 2021 nd then the code can be simplified and the
backport functionality can be removed then.

When generating multiple providers, only those that have version
that has no corresponding `providers-<PROVIDER>/<VERSION>` are
generated. Other providers are skipped with warnings.

Old documentation is removed and new CHANGELOG.rst have been
prepared for all providers to accomodate to the new process
(which is comming as a follow-up commit)

Fixes: #13272, #13271, #13274, #13276, #13277, #13275, #13273
(cherry picked from commit ac2f72c)
potiuk added a commit that referenced this issue Mar 3, 2021
@potiuk
Implement provider versioning tools (#13767)
07d924d 
This change implements per-provider versioning tools. Version of the
providers is retrieved from provider.yaml file (top-level verion).
Documentation is generated in the documentation folder rather than
in sources and embedded in provider's index. Backport providers
remain as they were until we delete all the backport references in
April 2021 nd then the code can be simplified and the
backport functionality can be removed then.

When generating multiple providers, only those that have version
that has no corresponding `providers-<PROVIDER>/<VERSION>` are
generated. Other providers are skipped with warnings.

Old documentation is removed and new CHANGELOG.rst have been
prepared for all providers to accomodate to the new process
(which is comming as a follow-up commit)

Fixes: #13272, #13271, #13274, #13276, #13277, #13275, #13273
(cherry picked from commit ac2f72c)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@potiuk potiuk

Labels
AIP-8 - Provider packages
Projects
None yet
Milestone
apache-airflow-providers-google v2
Development

No branches or pull requests
2 participants
@potiuk @debodirno