Skip to content

Commit c08a2a4

Browse files
Copilottheletterf
andauthored
Add "Contribute to the docs" link to sidebar and fix "View as Markdown" capitalization (#2082)
* Initial plan * Add contribution link and fix markdown capitalization Co-authored-by: theletterf <[email protected]> * Update progress - all code changes complete Co-authored-by: theletterf <[email protected]> * Add _static to gitignore Co-authored-by: theletterf <[email protected]> * Remove accidentally committed build artifact Co-authored-by: theletterf <[email protected]> * Update contribution link to point to elastic.co and open in new window Co-authored-by: theletterf <[email protected]> * Make contribution link smaller and align with Edit this page text Co-authored-by: theletterf <[email protected]> * Move padding to li element for proper text indentation Co-authored-by: theletterf <[email protected]> * Make contribution link a standard item with documents icon Co-authored-by: theletterf <[email protected]> * Make icon blue and shorten text to "Contribute to the docs" Co-authored-by: theletterf <[email protected]> * Update _TableOfContents.cshtml * Update on-the-web.md * Update _TableOfContents.cshtml * Update .gitignore --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: theletterf <[email protected]> Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
1 parent acfb5dc commit c08a2a4

File tree

2 files changed

+19
-7
lines changed

2 files changed

+19
-7
lines changed

docs/contribute/on-the-web.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This section will help you understand how to update and contribute to our documentation post-migration.
44

5+
:::{tip}
6+
Every documentation page includes a **Learn how to contribute** link in the sidebar that takes you to the [Elastic Docs contribution guide](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/). Use it whenever you want to contribute!
7+
:::
8+
59
## Updating documentation
610

711
:::{include} _snippets/two-systems.md
@@ -56,4 +60,4 @@ If you need to merge changes that are published in both systems (usually because
5660

5761
## Migration considerations
5862

59-
During the migration, content may be moved around, and there won't be a 1-to-1 mapping between old and new locations. This means updates may need to be applied in multiple places. If your changes affect /guide content, consider merging those changes in the /docs content first and then add it to the appropriate /guide content. If you have any issues, create an issue in the [`docs-content`](https://github.com/elastic/docs-content) or [`docs-content-internal`](https://github.com/elastic/docs-content-internal) repository.
63+
During the migration, content may be moved around, and there won't be a 1-to-1 mapping between old and new locations. This means updates may need to be applied in multiple places. If your changes affect /guide content, consider merging those changes in the /docs content first and then add it to the appropriate /guide content. If you have any issues, create an issue in the [`docs-content`](https://github.com/elastic/docs-content) or [`docs-content-internal`](https://github.com/elastic/docs-content-internal) repository.

src/Elastic.Markdown/Layout/_TableOfContents.cshtml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,15 @@
1212
<svg class="link-icon" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 -1 24 24">
1313
<path fill="currentColor" d="M22.131725 19.247H1.9386225C1.0239525 19.247 0.25 18.47305 0.25 17.558375v-11.11675c0 -0.914675 0.7739525 -1.688625 1.6886225 -1.688625H22.061375c0.914675 0 1.688625 0.77395 1.688625 1.688625v11.11675c0 0.914675 -0.7036 1.688625 -1.618275 1.688625ZM1.9386225 5.87875c-0.2814375 0 -0.562875 0.281425 -0.562875 0.562875v11.11675c0 0.3518 0.2814375 0.562875 0.562875 0.562875H22.061375c0.3518 0 0.562875 -0.281425 0.562875 -0.562875v-11.11675c0 -0.3518 -0.281425 -0.562875 -0.562875 -0.562875l-20.1227525 0ZM3.62725 15.86975V8.130225h2.2515l2.2515 2.814375 2.251475 -2.814375h2.2515V15.86975h-2.2515V11.437125L8.13025 14.2515l-2.2515 -2.814375V15.86975h-2.2515Zm14.1422 0L14.392225 12.140725h2.251475v-4.0105h2.2515v3.940125h2.2515L17.76945 15.86975Z" stroke-width="0.25"></path>
1414
</svg>
15-
View as markdown
15+
View as Markdown
16+
</a>
17+
</li>
18+
<li class="report-an-issue lg:not-first:mt-1">
19+
<a href="@Model.ReportIssueUrl" class="link text-sm" target="_blank">
20+
<svg class="link-icon" viewBox="0 0 98 96" xmlns="http://www.w3.org/2000/svg">
21+
<path fill-rule="evenodd" clip-rule="evenodd" d="M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z" fill="currentColor"/>
22+
</svg>
23+
Report an issue
1624
</a>
1725
</li>
1826
@if (!string.IsNullOrEmpty(Model.GithubEditUrl))
@@ -26,12 +34,12 @@
2634
</a>
2735
</li>
2836
}
29-
<li class="report-an-issue lg:not-first:mt-1">
30-
<a href="@Model.ReportIssueUrl" class="link text-sm" target="_blank">
31-
<svg class="link-icon" viewBox="0 0 98 96" xmlns="http://www.w3.org/2000/svg">
32-
<path fill-rule="evenodd" clip-rule="evenodd" d="M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z" fill="currentColor"/>
37+
<li class="learn-how-to-contribute hidden lg:block lg:not-first:mt-1">
38+
<a href="https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/" class="link text-sm" target="_blank">
39+
<svg class="link-icon" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16">
40+
<path fill="currentColor" d="M8.8,0 C9.074,0 9.337,0.113 9.526,0.312 L12.726,3.74 C12.902,3.926 13,4.173 13,4.429 L13,13 C13,13.552 12.552,14 12,14 L2,14 C1.448,14 1,13.552 1,13 L1,1 C1,0.448 1.448,0 2,0 L8.8,0 Z M12,5 L8.5,5 C8.224,5 8,4.776 8,4.5 L8,1 L2,1 L2,13 L12,13 L12,5 Z M4.5,11 C4.22385763,11 4,10.7761424 4,10.5 C4,10.2238576 4.22385763,10 4.5,10 L9.5,10 C9.7761424,10 10,10.2238576 10,10.5 C10,10.7761424 9.7761424,11 9.5,11 L4.5,11 Z M4.5,8 C4.22385763,8 4,7.77614237 4,7.5 C4,7.22385763 4.22385763,7 4.5,7 L9.5,7 C9.7761424,7 10,7.22385763 10,7.5 C10,7.77614237 9.7761424,8 9.5,8 L4.5,8 Z M5.5,16 C5.22385763,16 5,15.7761424 5,15.5 C5,15.2238576 5.22385763,15 5.5,15 L14,15 L14,6.5 C14,6.22385763 14.2238576,6 14.5,6 C14.7761424,6 15,6.22385763 15,6.5 L15,15 C15,15.5522847 14.5522847,16 14,16 L5.5,16 Z"/>
3341
</svg>
34-
Report an issue
42+
Learn how to contribute
3543
</a>
3644
</li>
3745
</ul>

0 commit comments

Comments
 (0)