You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Suggest an idea for improving docs-builder.
3
+
title: "[Feature Request]: "
4
+
labels: ["enhancement"]
5
+
body:
6
+
- type: markdown
7
+
attributes:
8
+
value: |
9
+
Thanks for taking the time to suggest an improvement to docs-builder! Please fill out this form as completely as possible.
10
+
11
+
- type: checkboxes
12
+
attributes:
13
+
label: Prerequisites
14
+
description: Please verify you have completed the following
15
+
options:
16
+
- label: I have searched existing issues to ensure this feature hasn't already been requested
17
+
required: true
18
+
- label: I have tested using the latest version of docs-builder
19
+
required: true
20
+
21
+
- type: textarea
22
+
id: problem
23
+
attributes:
24
+
label: What problem are you trying to solve?
25
+
description: |
26
+
Describe the context and limitation you're encountering. Remember that it might not be obvious to others why this is important!
27
+
placeholder: |
28
+
Example: When building documentation for my project, I often need to update the revision date at the top of each file. Currently, I have to manually edit each file, which is time-consuming and error-prone.
29
+
validations:
30
+
required: true
31
+
32
+
- type: textarea
33
+
id: solution
34
+
attributes:
35
+
label: Proposed Solution
36
+
description: |
37
+
Describe your proposed solution. Include as much detail as you can, but remember that there might be other solutions we haven't thought of!
38
+
placeholder: |
39
+
Example: Add a CLI flag --auto-update-revision-date that automatically updates a specified metadata field in all documentation files when building.
40
+
validations:
41
+
required: true
42
+
43
+
- type: textarea
44
+
id: examples
45
+
attributes:
46
+
label: Examples and Research
47
+
description: |
48
+
Please provide any relevant examples, research, or references that support this feature request:
49
+
- Similar features in other documentation tools
50
+
- Code samples showing how you'd use this feature
51
+
- Links to relevant standards or conventions
52
+
- Screenshots or diagrams of your proposed solution
53
+
placeholder: |
54
+
- MkDocs has a similar feature using their `git-revision-date-localized` plugin
55
+
- Jekyll's `last_modified_at` plugin demonstrates this functionality
56
+
validations:
57
+
required: false
58
+
59
+
- type: textarea
60
+
id: alternatives
61
+
attributes:
62
+
label: Alternative Solutions
63
+
description: |
64
+
What alternative solutions have you considered or tried? Why aren't they sufficient?
65
+
placeholder: |
66
+
I've tried using git hooks to update the dates, but this doesn't work well in CI/CD pipelines.
67
+
validations:
68
+
required: false
69
+
70
+
- type: textarea
71
+
id: additional-context
72
+
attributes:
73
+
label: Additional Context
74
+
description: Add any other context about the feature request here.
75
+
placeholder: |
76
+
- This would be particularly useful for compliance documentation where revision dates are mandatory
77
+
- Could potentially integrate with git history for more accurate dating
Want to contribute to the Elastic documentation? You're in the right spot! Select an option below to get started:
6
+
Welcome, **contributor**!
7
7
8
-
* I just want to suggest a change --> [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml)
9
-
* I want to make a small change to a single page --> [Update the docs in your _web browser_](change-browser.md).
10
-
* I want to make a larger change or a change to multiple pages --> [Update the docs in your _code editor_](change-local.md).
8
+
Whether you're a technical writer or you've only edited Elastic docs once or twice, you're a valued contributor. Every word matters!
9
+
10
+
## Contribute to the docs [#contribute]
11
+
12
+
* Simple bugs and enhancements --> [Contribute on the web](on-the-web.md)
13
+
* Complex or multi-page updates --> [Contribute locally](locally.md)
14
+
15
+
## Report a bug
16
+
17
+
* It's a **documentation** problem --> [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml)*or*[Fix it myself](locally.md)
18
+
* It's a **build tool (docs-builder)** problem --> [Open a bug report](https://github.com/elastic/docs-builder/issues/new?template=bug-report.yaml)
19
+
* It's a **migration tooling** problem --> [Open a bug report](https://github.com/elastic/docs-builder/issues/new?template=bug-report.yaml)
20
+
21
+
## Request an enhancement
22
+
23
+
* Make the **documentation** better --> [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml)
24
+
* Make our **build tool (docs-builder)** better --> [Open a docs-builder issue](https://github.com/elastic/docs-builder/issues/new?template=enhancement.yaml)
25
+
26
+
## Work on docs-builder
27
+
28
+
That sounds great! See [development](../development/index.md) to learn how to contribute to our documentation build system.
Copy file name to clipboardExpand all lines: docs/source/index.md
+13-3Lines changed: 13 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,18 @@
1
1
---
2
-
title: Elastic Docs v3
2
+
title: Welcome to Elastic Docs v3
3
3
---
4
4
5
-
You've reached the home of the latest incarnation of the documentation tooling.
5
+
Elastic Docs V3 is our next-generation documentation platform designed to improve the experience of learning, using, and contributing to Elastic products. Built on a foundation of modern authoring tools and scalable infrastructure, V3 offers faster builds, streamlined versioning, and enhanced navigation to guide users through Elastic’s complex ecosystem.
6
+
7
+
**What do you want to do today?**
8
+
9
+
*[Contribute to Elastic documentation](/contribute/index.html)
10
+
*[Learn about migration to Elastic Docs V3](/migration/index.html)
11
+
*[Configure content sets in V3](/configure/index.html)
12
+
*[Learn about V3 syntax](/syntax/index.html)
13
+
*[Contribute to V3 (developer guide)](/development/index.html)
This GitHub Action enforces documentation freezes by adding comments to pull requests that modify `.asciidoc` files. It complements the use of `CODEOWNERS` to ensure changes during a freeze period are reviewed and approved by the `@docs-freeze-team`.
7
+
8
+
## How It Works
9
+
1.**Trigger**: The Action is triggered on pull request events (`opened`, `reopened`, or `synchronize`).
10
+
2.**Check Changes**: It checks the diff between the latest commits to detect modifications to `.asciidoc` files.
11
+
3.**Add Comment**: If changes are detected, the Action posts a comment in the pull request, reminding the contributor of the freeze.
12
+
13
+
```yaml
14
+
name: Comment on PR for .asciidoc changes
15
+
16
+
on:
17
+
pull_request:
18
+
types:
19
+
- synchronize
20
+
- opened
21
+
- reopened
22
+
23
+
jobs:
24
+
comment-on-asciidoc-change:
25
+
runs-on: ubuntu-latest
26
+
27
+
steps:
28
+
- name: Checkout the repository
29
+
uses: actions/checkout@v3
30
+
31
+
- name: Check for changes in .asciidoc files
32
+
id: check-files
33
+
run: |
34
+
if git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep -E '\.asciidoc$'; then
body: 'It looks like this PR modifies one or more `.asciidoc` files. The documentation is currently under a documentation freeze. Please do not merge this PR. See [link](link) to learn more.'
0 commit comments