[Feature Request]: Subscribe or receive notification on known issues page updates
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Active
- Domain
- documentation
Research direction
Start by reviewing the docs-builder project and the linked known issues page, then read the referenced Slack conversation for context. Define whether the first scope is page subscriptions, email notifications, or an RSS/Atom feed, and document how updates would be detected and delivered; done means an agreed, implementable scope for known-issues pages.
Written by the indexing model from the issue text.
Description
Additional Context
Customer request highlighted in internal feedback: Teams experiencing frequent bugs and using specific versions wish for proactive notifications, not just updates at planned upgrades. This is related to upcoming changes in release notes and was discussed but is not on the roadmap yet. See Slack thread for details.
Alternative Solutions
Currently, users must manually check the known issues page for updates; this is not scalable or proactive and can lead to missed important issues, especially for customers dealing with unstable or bug-prone configurations. There are no alternatives for doc-specific subscription currently available.
Examples and Research
- Many documentation systems (e.g., Read the Docs, Confluence) provide a "watch" or "subscribe" feature for specific pages or sections.
- RSS/Atom feeds are a common way to enable subscriptions to page updates.
- Enabling such a feature for https://www.elastic.co/docs/release-notes/elasticsearch/known-issues would address direct customer requests.
How important is this feature to you?
"Important"
What problem are you trying to solve?
Currently, there is no way for customers to subscribe to updates or receive notifications when new known issues are uncovered in the documentation (for example, https://www.elastic.co/docs/release-notes/elasticsearch/known-issues). Customers with many issues, especially on specific versions, want to proactively know when something new is discovered rather than only finding out when they come back to review the list during a planned upgrade.
Proposed Solution
Implement a mechanism in docs-builder to enable subscription (e.g., email or reminder) to changes or new entries in known issues pages across the docs. Ideally, this would allow users to receive notifications when these pages are updated, either as a native feature, integration with an external service, or even RSS/Atom feeds. This could be generalized for other important doc pages in future.
Prerequisites
false,false
- Dominant language
- C#
- Stars
- 25
- Forks
- 44
- Avg merge
- 22h 15m
- Merged PRs (30d)
- 162
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from elastic/docs-builder
-
chore needs triage tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
elastic/docs-builder#3567 · 1 comment ·
-
chore needs triage tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
elastic/docs-builder#3566 · 1 comment ·
-
ai-triaged bug needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
elastic/docs-builder#3045 · 4 comments ·
-
ai-triaged ai:eng-question ai:product-question bug needs triage stale
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
elastic/docs-builder#2397 · 2 comments ·
-
ai-triaged ai:quick-fix ai:writer-question documentation needs triage stale
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
elastic/docs-builder#2006 · 3 comments ·
All issues in elastic/docs-builder
Similar issues
-
type/automation type/tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
t/bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
ci-failure-cause test-failure
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area:auth FE mvp P3
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
klasolsson81/jobbliggaren#1788 ·