drafting where to work #768
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request adds a new documentation page outlining guidelines for determining where to make contributions across various Elastic product areas.
- Introduces an overview of contribution pathways for content based on version (9.0+ vs. pre-9.0)
- Details product-specific sections for Kibana, Elasticsearch, Cloud, and Machine Learning
- Provides a mapping table for IA sections to product areas
| @@ -0,0 +1,99 @@ | |||
|
|
|||
| # **How do I know where to contribute?** | |||
There was a problem hiding this comment.
How do I know where to contribute?
A very brief drive-by comment that this content seems like it should be integrated with or replace what's in https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/#contribute
|
|
||
| 1. **Reference/settings content** lives in the new Markdown files in the code repo as it did pre 9.0. This enables folks to make updates that touch code \+ low-level docs in the same PR. | ||
| 2. **Narrative/conceptual and overview content** lives in [elastic/docs-content](https://github.com/elastic/docs-content). As an example the [ES|QL overview](https://docs-v3-preview.elastic.dev/elastic/docs-content/tree/main/explore-analyze/query-filter/languages/esql) lives in the **Explore & Analyze** section of the narrative docs. But the reference documentation lives in the reference section of the docs [ES|QL reference](https://docs-v3-preview.elastic.dev/elastic/elasticsearch/tree/main/reference/query-languages/esql) | ||
| 3. **API reference docs** live in the different OpenAPI spec repositories. This is where you need to update API docs published in the new API docs system |
There was a problem hiding this comment.
API reference docs live in the different OpenAPI spec repositories. This is where you need to update API docs published in the new API docs system
If this content is going to persist as a public-facing document that we point all external and internal contributors to, I'm happy to beef up the "how to contribute to API docs" content here too.
|
|
||
| ### **Kibana** | ||
|
|
||
| #### **What has moved to elastic/docs-content?** |
There was a problem hiding this comment.
What has moved to elastic/docs-content?
IMO this feels like info that's only really relevant for internal contributors and overcomplicates things for external contributors. Is it worth splitting this content into separate sections aimed at external contributors (i.e. as simple as possible, open issue or click edit link) and internal contributors (i.e. where did the files I used to have go? how do I backport? etc)
No description provided.