MukundaKatta opened a new pull request, #1135:
URL: https://github.com/apache/pulsar-site/pull/1135
### Motivation
Closes apache/pulsar#23150 (partial).
The reporter pointed out that common keywords ("Topic", "Subscription",
"Producer", "Consumer", "Broker", etc.) appear unlinked across the user-facing
docs, so new readers can't easily click through to the primary definition pages.
### Modifications
This PR seeds the linking pattern on a small, high-traffic starter set so
the rest of the docs can follow incrementally without a single mega-PR:
- `docs/getting-started-home.md` - link
Topic/Subscription/Producer/Consumer/Cluster from the entry-point summary line.
- `docs/getting-started-standalone.md` - link Cluster, BookKeeper, Topics,
Producer, Consumer at first mention in each step.
- `docs/getting-started-docker.md` - link Broker, Metadata store, Namespace,
Topic, Producer, Consumer.
- `docs/concepts-architecture-overview.md` - link Producers, Consumers,
BookKeeper, Metadata store, Topics, Tenants, Namespaces from the intro
paragraphs and the Brokers/Clusters sections.
Targets:
- `concepts-clients.md#producer`, `#consumer`
- `concepts-messaging.md#topics`, `#subscriptions`, `#namespaces`
- `concepts-architecture-overview.md#brokers`, `#clusters`,
`#metadata-store`, `#apache-bookkeeper`
- `concepts-multi-tenancy.md`, `schema-overview.md`, etc.
Existing links and code blocks are not touched; only first-mention prose
terms are linked, matching the style already used in `concepts-overview.md` and
`concepts-messaging.md`.
### Verifying this change
- This change is a trivial rework / code cleanup without any test coverage.
Visual review: each link target was verified against the corresponding
page's section heading (kebab-case anchors).
### Does this pull request potentially affect one of the following parts:
- [ ] Dependencies (add or upgrade a dependency)
- [ ] The public API
- [ ] The schema
- [ ] The default values of configurations
- [ ] The threading model
- [ ] The binary protocol
- [ ] The REST endpoints
- [ ] The admin CLI options
- [ ] The metrics
- [ ] Anything that affects deployment
### Documentation
- [x] `doc-not-needed`
This PR is itself a docs-only change; no separate docs ticket needed.
### Matching PR in forked repository
PR in forked repository: docs/keyword-hyperlinks-23150
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
