Content-Length: 485555 | pFad | https://github.com/googleapis/google-cloud-python/issues/5912

57 Docs: prepare for repo split · Issue #5912 · googleapis/google-cloud-python · GitHub
Skip to content

Docs: prepare for repo split #5912

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
Closed
31 tasks done
tseaver opened this issue Sep 10, 2018 · 1 comment
Closed
31 tasks done

Docs: prepare for repo split #5912

tseaver opened this issue Sep 10, 2018 · 1 comment
Assignees
@tseaver
Labels
api: bigquery Issues related to the BigQuery API. api: bigtable Issues related to the Bigtable API. api: clouderrorreporting Issues related to the Error Reporting API. api: cloudresourcemanager Issues related to the Resource Manager API. api: cloudtrace Issues related to the Cloud Trace API. api: core api: datastore Issues related to the Datastore API. api: dns Issues related to the Cloud DNS API. api: firestore Issues related to the Firestore API. api: language Issues related to the Cloud Natural Language API API. api: logging Issues related to the Cloud Logging API. api: pubsub Issues related to the Pub/Sub API. api: runtimeconfig Issues related to the Cloud Runtime Config API API. api: spanner Issues related to the Spanner API. api: speech Issues related to the Speech-to-Text API. api: storage Issues related to the Cloud Storage API. api: translation Issues related to the Cloud Translation API API. type: docs Improvement to the documentation for an API.

Comments

@tseaver
Copy link
Contributor

tseaver commented Sep 10, 2018 •
edited
Loading

/cc @theacodes FYR.

Because the "documentation root" changes for inclusions between the monorepo docs build and the per-package docs build, we have to do this in two phases.

Steps before the split:

  • For packages whose canonical docs are not symlinks into their own docs/ tree, move their contents to that directory and set up symlinks. Test that top-level docs still generate correctly via symlinks.
  • For all packages, harmonize / de-duplicate their README.rst with the docs/index.rst landing page (see PR Docs: Replace links to '/stable/' with '/latest/'. #5901 / commit 26efddf for recently-generated packages).
  • If landing page is renamed (e.g. from usage.rst -> index.rst), leave behind a redirect page (see bigquery/docs/usage.html) and link it in docs/conf.py.
  • Remove any generation / mutation of README.rst / docs/index.rst from synth.py.

GA packages:

Beta packages:

Alpha packages:

Not-yet-released packages:

After the split:

  • Add docs/conf.py to all packages which don't have it (fix up bitrot for those which do).
  • Add a nox -e docs target for all packages and test.
  • Sync any redirect pages added in umbrella docs/conf.py with local docs/conf.py.
@tseaver tseaver added api: datastore Issues related to the Datastore API. api: storage Issues related to the Cloud Storage API. api: bigquery Issues related to the BigQuery API. api: dns Issues related to the Cloud DNS API. api: pubsub Issues related to the Pub/Sub API. api: core api: bigtable Issues related to the Bigtable API. api: cloudresourcemanager Issues related to the Resource Manager API. api: logging Issues related to the Cloud Logging API. api: translation Issues related to the Cloud Translation API API. api: speech Issues related to the Speech-to-Text API. api: runtimeconfig Issues related to the Cloud Runtime Config API API. api: spanner Issues related to the Spanner API. api: clouderrorreporting Issues related to the Error Reporting API. api: language Issues related to the Cloud Natural Language API API. api: cloudtrace Issues related to the Cloud Trace API. api: firestore Issues related to the Firestore API. type: docs Improvement to the documentation for an API. labels Sep 10, 2018
@theacodes
Copy link
Contributor

theacodes commented Sep 10, 2018 via email

@tseaver tseaver mentioned this issue Sep 11, 2018
Merged
tseaver added a commit that referenced this issue Sep 11, 2018
@tseaver
Prep datastore docs for repo split. (#5919)
4d9f6a5 
- Move docs from 'docs/datastore' into 'datastore/docs' and leave symlink.
- Harmonize / DRY 'datastore/README.rst' and 'datastore/docs/index.rst'.
- Remove docs for GAPIC-generated bits (they aren't part of the surface).
- Ensure that docs still build from top-level.

Toward #5912.
@tseaver tseaver mentioned this issue Sep 11, 2018
Merged
tseaver added a commit that referenced this issue Sep 11, 2018
@tseaver
Prep storage docs for repo split. (#5923)
57d25c2 
- Move docs from 'docs/storage' into 'storage/docs' and leave symlink.
- Harmonize / DRY 'storage/README.rst' and 'storage/docs/index.rst'.
- Ensure that docs still build from top-level.

Toward #5912.
This was referenced Sep 11, 2018
Merged
Merged
Merged
Merged
Merged
tseaver added a commit that referenced this issue Sep 12, 2018
@tseaver
Prep language docs for repo split. (#5932)
7a7a83d 
- Move docs from 'docs/language' into 'language/docs' and leave symlink.
- Harmonize / DRY 'language/README.rst' and 'language/docs/index.rst'.
- Ensure that docs still build from top-level.

Toward #5912.
tseaver added a commit that referenced this issue Sep 12, 2018
@tseaver
Prep spanner docs for repo split. (#5938)
b97b8e8 
- Move docs from 'docs/spanner' into 'spanner/docs' and leave symlink.
- Harmonize / DRY 'spanner/README.rst' and 'spanner/docs/index.rst'.
- Ensure that docs still build from top-level.

Toward #5912.
@tseaver tseaver mentioned this issue Sep 19, 2018
Merged
tseaver added a commit that referenced this issue Sep 19, 2018
@tseaver
Dataproc: harmonize / DRY 'README.rst' / 'docs/index.rst'.
0abfc26 
Toward #5912.
This was referenced Sep 19, 2018
Merged
Merged
tseaver added a commit that referenced this issue Sep 19, 2018
@tseaver
KMS: harmonize / DRY 'README.rst' / 'docs/index.rst'.
354dc7a 
Toward #5912.
@tseaver tseaver mentioned this issue Sep 19, 2018
Merged
tseaver added a commit that referenced this issue Sep 19, 2018
@tseaver
Prep resource-manager docs for repo split.
c8528de 
- Move contents of 'docs/resource-manager/' to 'resource-manager/docs'.
- Harmonize / DRY 'resource-manager/README.rst' with
  'resource-manager/docs/index.rst'.

Toward #5912
tseaver added a commit that referenced this issue Sep 19, 2018
@tseaver
Resource-manager: prep docs for repo split.
52562b0 
- Move contents of 'docs/resource-manager/' to 'resource-manager/docs',
  leaving behind a symlink.

Toward #5912
@tseaver tseaver mentioned this issue Sep 19, 2018
Merged
tseaver added a commit that referenced this issue Sep 19, 2018
@tseaver
Prep runtimeconfig docs for repo split.
89c07d8 
- Move contents of 'docs/runtimeconfig/' to 'runtimeconfig/docs'.
- Rename 'runtimeconfig/docs/usage.rst' to 'runtimeconfig/docs/index.rst',
  and add a static redirect page, 'runtimeconfig/docs/usage.html'.
- Harmonize / DRY 'runtimeconfig/README.rst' / 'runtimeconfig/docs/index.rst'.

Toward #5912
@tseaver tseaver mentioned this issue Sep 19, 2018
Merged
tseaver added a commit that referenced this issue Sep 19, 2018
@tseaver
Prep trace docs for repo split.
32c961f 
- Move contents of 'docs/trace/' to 'trace/docs'.
- Harmonize / DRY 'trace/README.rst' with 'trace/docs/index.rst'.
- Adjust generated V1 docstrings to allow Sphinx to build.

Toward #5912.
tseaver added a commit that referenced this issue Sep 19, 2018
@tseaver
Trace: prep docs for repo split.
f528527 
- Remove contents of 'docs/trace/', and replace w/ symlink to 'trace/docs'.
- Harmonize / DRY 'trace/README.rst' with 'trace/docs/index.rst'.
- Adjust generated V1 docstrings to allow Sphinx to build.

Toward #5912.
@tseaver tseaver mentioned this issue Sep 19, 2018
Merged
tseaver added a commit that referenced this issue Sep 19, 2018
@tseaver
runtimeconfig: prep docs for repo split. (#6023)
37c1f9e 
- Move contents of 'docs/runtimeconfig/' to 'runtimeconfig/docs'.
- Rename 'runtimeconfig/docs/usage.rst' to 'runtimeconfig/docs/index.rst',
  and add a static redirect page, 'runtimeconfig/docs/usage.html'.
- Harmonize / DRY 'runtimeconfig/README.rst' / 'runtimeconfig/docs/index.rst'.

Toward #5912
tseaver added a commit that referenced this issue Sep 21, 2018
@tseaver
Container: harmonize / DRY 'README.rst' / 'docs/index.rst'. (#6018)
e0fe9a2 
Toward #5912.
tseaver added a commit that referenced this issue Sep 21, 2018
@tseaver
Dataproc: harmonize / DRY 'README.rst' / 'docs/index.rst'. (#6019)
01aad20 
Toward #5912.
tseaver added a commit that referenced this issue Sep 21, 2018
@tseaver
KMS: harmonize / DRY 'README.rst' / 'docs/index.rst'. (#6021)
35684f0 
Toward #5912.
This was referenced Oct 3, 2018
Merged
Merged
tseaver added a commit that referenced this issue Oct 17, 2018
@tseaver
Error_reporting: prep docs for repo split. (#6155)
ec5e02e 
* Harmonize / DRY 'error_reporting/README.rst' / 'error_reporting/docs/index.rst'.

Toward #5912.

* Move 'docs/error-reporting/*' -> 'error_reporting/docs/'.

Leave behind a symlink (note its name uses a hyphen rather than an
underscore).

Make the 'usage.rst' page only do usage docs -- the rest is in 'index.rst'.
tseaver added a commit that referenced this issue Oct 17, 2018
@tseaver
Harmonize / DRY 'monitoring/README.rst' / 'monitoring/docs/index.rst'. (
609a48d 
#6156)

Toward #5912.
@tseaver tseaver closed this as completed Dec 4, 2018
parthea pushed a commit that referenced this issue Jul 6, 2023
@tseaver
Prep language docs for repo split. (#5932)
bae8ea9 
- Move docs from 'docs/language' into 'language/docs' and leave symlink.
- Harmonize / DRY 'language/README.rst' and 'language/docs/index.rst'.
- Ensure that docs still build from top-level.

Toward #5912.
parthea pushed a commit that referenced this issue Sep 22, 2023
@tseaver
Container: harmonize / DRY 'README.rst' / 'docs/index.rst'. (#6018)
dd78d26 
Toward #5912.
parthea pushed a commit that referenced this issue Sep 22, 2023
@tseaver
Dataproc: harmonize / DRY 'README.rst' / 'docs/index.rst'. (#6019)
5581ac9 
Toward #5912.
parthea pushed a commit that referenced this issue Oct 21, 2023
@tseaver
KMS: harmonize / DRY 'README.rst' / 'docs/index.rst'. (#6021)
3f7e691 
Toward #5912.
parthea pushed a commit that referenced this issue Oct 21, 2023
@tseaver
Harmonize / DRY 'monitoring/README.rst' / 'monitoring/docs/index.rst'. (
4df3af0 
#6156)

Toward #5912.
parthea pushed a commit that referenced this issue Oct 21, 2023
@tseaver
Prep translate docs for repo split. (#5941)
2c9beb4 
- Move docs from 'docs/translate' into 'translate/docs' and leave symlink.
- Harmonize / DRY 'translate/README.rst' and 'translate/docs/index.rst'.
- Ensure that docs still build from top-level.

Toward #5912.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tseaver tseaver

Labels
api: bigquery Issues related to the BigQuery API. api: bigtable Issues related to the Bigtable API. api: clouderrorreporting Issues related to the Error Reporting API. api: cloudresourcemanager Issues related to the Resource Manager API. api: cloudtrace Issues related to the Cloud Trace API. api: core api: datastore Issues related to the Datastore API. api: dns Issues related to the Cloud DNS API. api: firestore Issues related to the Firestore API. api: language Issues related to the Cloud Natural Language API API. api: logging Issues related to the Cloud Logging API. api: pubsub Issues related to the Pub/Sub API. api: runtimeconfig Issues related to the Cloud Runtime Config API API. api: spanner Issues related to the Spanner API. api: speech Issues related to the Speech-to-Text API. api: storage Issues related to the Cloud Storage API. api: translation Issues related to the Cloud Translation API API. type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tseaver @theacodes








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: https://github.com/googleapis/google-cloud-python/issues/5912

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy