Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Docs: prepare for repo split #5912

Copy link
Copy link
Closed
Closed
Copy link
@tseaver

Description

@tseaver
Issue body actions

/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.

Metadata

Metadata

Assignees

Labels

api: bigqueryIssues related to the BigQuery API.Issues related to the BigQuery API.api: bigtableIssues related to the Bigtable API.Issues related to the Bigtable API.api: clouderrorreportingIssues related to the Error Reporting API.Issues related to the Error Reporting API.api: cloudresourcemanagerIssues related to the Resource Manager API.Issues related to the Resource Manager API.api: cloudtraceIssues related to the Cloud Trace API.Issues related to the Cloud Trace API.api: coreapi: datastoreIssues related to the Datastore API.Issues related to the Datastore API.api: dnsIssues related to the Cloud DNS API.Issues related to the Cloud DNS API.api: firestoreIssues related to the Firestore API.Issues related to the Firestore API.api: languageIssues related to the Cloud Natural Language API API.Issues related to the Cloud Natural Language API API.api: loggingIssues related to the Cloud Logging API.Issues related to the Cloud Logging API.api: pubsubIssues related to the Pub/Sub API.Issues related to the Pub/Sub API.api: runtimeconfigIssues related to the Cloud Runtime Config API API.Issues related to the Cloud Runtime Config API API.api: spannerIssues related to the Spanner API.Issues related to the Spanner API.api: speechIssues related to the Speech-to-Text API.Issues related to the Speech-to-Text API.api: storageIssues related to the Cloud Storage API.Issues related to the Cloud Storage API.api: translationIssues related to the Cloud Translation API API.Issues related to the Cloud Translation API API.type: docsImprovement to the documentation for an API.Improvement to the documentation for an API.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    Morty Proxy This is a proxified and sanitized view of the page, visit original site.