docs/hostnames: Normalize placeholder hostnames to *.example.com - #1932
Draft
marcleblanc2 wants to merge 3 commits into
Draft
docs/hostnames: Normalize placeholder hostnames to *.example.com#1932marcleblanc2 wants to merge 3 commits into
marcleblanc2 wants to merge 3 commits into
Conversation
Standardize on sourcegraph.example.com for "your Sourcegraph instance" (replacing your-sourcegraph-instance.com, sourcegraph.company.com, sourcegraph.your*.com, *.sourcegraph.com placeholders, sourcegraph.test:3443, src.acme.com, and URL-style angle-bracket placeholders), and on <service>.example.com for code hosts and infra (my-*.example.com, bitbucketserver/your-bbs-instance, github-enterprise, smtp-server, *.company.net, bitbucket.sgdev.org). Auto-generated SCHEMA_SYNC blocks and the technical changelog are left untouched; the schema descriptions must be fixed upstream. Co-authored-by: Amp <amp@ampcode.com> Amp-Thread-ID: https://ampcode.com/threads/T-01a07e6a-e26f-753a-8486-cd5b81a79672
… *.example.com Postgres, PgBouncer, Redis, Grafana, Prometheus, registry, and external pgsql example hosts, plus the CAA dig example in the Cloud docs. Amp-Thread-ID: https://ampcode.com/threads/T-01a07e6a-e26f-753a-8486-cd5b81a79672 Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-01a07e6a-e26f-753a-8486-cd5b81a79672 Co-authored-by: Amp <amp@ampcode.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
No description provided. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The docs used ~20 different spellings for "your Sourcegraph instance" and a handful of inconsistent code-host placeholders. This PR standardizes them:
sourcegraph.example.com(already the incumbent at ~150 uses). Replacesyour-sourcegraph-instance.com(25),sourcegraph.company.com/.io,sourcegraph.yourcompany.com,sourcegraph.yourdomain.com,sourcegraph.your-domain.com,sourcegraph.your_instance_name.com,sourcegraph.mycompany.com,myinstance/yourinstance/yourdomain/example.sourcegraph.com,sourcegraph.test:3443,src.acme.com, and URL-position placeholders (https://<YOUR-SOURCEGRAPH-INSTANCE-URL>,<Sourcegraph URL>/.api,<sourcegraph-host>.com,$your_sourcegraph_url,SRC_ENDPOINT="YOUR_SOURCEGRAPH_URL").<service>.example.com:my-{gitlab,bitbucket,phabricator}.example.com,bitbucketserver.example.com,your-bbs-instance.example.com→bitbucket.example.com,github-enterprise.example.com→github.example.com,smtp-server.example.com→smtp.example.com,*.internal.company.net→*.internal.example.com, and an internalbitbucket.sgdev.orgrepo reference in a batch-changes example.<service>.example.com:grafana.mycompany.com,prometheus.mycompany.com,psql1/psql2.mycompany.org,redis.mycompany.org,sourcegraph-pgbouncer.mycompany.com,sourcegraph-codeintel-pgbouncer.mycompany.com,pgsql.database.company.com,myregistry.company.com, anddig acme.com caa→dig example.com caa.src.acme.com→sourcegraph.example.com,acme.sourcegraphcloud.com→example.sourcegraphcloud.com(matching the# e.g. example.sourcegraphcloud.comcomments elsewhere in the cloud docs).mycompany.onelogin.com→example.onelogin.com, with the "replacemycompany" instruction updated to match.Deliberately left alone
SCHEMA_SYNCblocks (src.example.com,my-*.example.com,artifactory.acme.com,swarm.company.comin JSON schema descriptions) — those must change upstream insourcegraph/sourcegraph.docs/technical-changelog.mdx(historical record).localhost:3080in local-install guides (genuinely local access, not a placeholder).<sourcegraph-instance>/campaigns/*and<INSTANCE_URL>(cloud, paired withexample.sourcegraphcloud.com).git.example.com/code.example.com.~100 line changes across 40 files; pure text substitution, no structural edits.
Amp threads
Replaces #1876 (branch renamed to
marc/docs/normalize-example-hostnames).