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

files getting excluded when regenerating index.rst #1766

Open
vchudnov-g opened this issue Sep 14, 2023 · 2 comments
Open

files getting excluded when regenerating index.rst #1766

vchudnov-g opened this issue Sep 14, 2023 · 2 comments
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API. type: process A process-related concern. May include testing, release, or the like.

Comments

@vchudnov-g
Copy link
Contributor

There are three kinds of erroneous exclusions from index.rst we noticed when reviewing googleapis/google-cloud-python#11635. The changes I had to manually make to fix these exclusions are shown here. We should fix our processes so this kind of manual fix is not needed. The omissions were:

  • sibling packages were excluded. In this case, the lines referring to executions below should have been present but weren't:
     workflows_v1/services
     executions_v1/services
     workflows_v1/types
     executions_v1/types
    
  • the "Changelog" section and its reference to the CHANGELOG file were excluded
  • the .. include:: directives were excluded

At least the last two of these exclusions were caught by docs presubmit failures, but they should not be happening at all.

(This issue may need to be moved to the owlbot repo, or link to new issues there.)

@vchudnov-g vchudnov-g added type: docs Improvement to the documentation for an API. type: process A process-related concern. May include testing, release, or the like. priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. labels Sep 14, 2023
@vchudnov-g
Copy link
Contributor Author

Labeling this P1 because of the toil involved.

@vchudnov-g vchudnov-g added priority: p2 Moderately-important priority. Fix may not be included in next release. and removed priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. labels Nov 28, 2023
@vchudnov-g
Copy link
Contributor Author

Lowering to P2 because we have a manual workaround when this arises, and it's not blocking releases. Our upcoming docs work will include automating this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API. type: process A process-related concern. May include testing, release, or the like.
Projects
None yet
Development

No branches or pull requests

1 participant