973dd6f25d
fix some little things that vale was complaining about
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2024-12-10 14:31:54 +01:00
062f6fdb56
docs(techdocs): Update Docker command to install mkdocs
...
Signed-off-by: Jan <herr.jan.heller@googlemail.com >
2024-11-22 13:13:58 +01:00
0df455f94b
Update how-to-guides.md
...
small grammar update
Signed-off-by: Alex Lorenzi <671432+alexlorenzi@users.noreply.github.com >
2024-11-14 16:53:22 -05:00
0c9bd0abe5
Updated mermaid installation docs
...
Signed-off-by: Alex Lorenzi <alorenzi@spotify.com >
2024-11-14 16:41:03 -05:00
4f0cb89c42
Add DomPurify sanitizer custom elements configuration ( #26989 )
...
* Add DomPurify sanitizer custom elements configuration
---------
Signed-off-by: Harsha Teja Kanna <h7kanna@gmail.com >
2024-10-17 13:21:56 -04:00
bc71718834
update docs to remove /alpha
...
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
2024-10-11 16:50:08 +02:00
fbdc63116c
feat(techdocs): Allow to pass options to GCS publisher ( #26836 )
...
* feat(techdocs): Allow to pass options to GCS publisher
Signed-off-by: Adrian Kosinski <adrian.kosinski@allegro.com >
---------
Signed-off-by: Adrian Kosinski <adrian.kosinski@allegro.com >
2024-10-01 13:40:47 -04:00
123d514d11
Merge pull request #25084 from wedge-jarrad/download-link-docs
...
Add examples for creating download links
2024-09-27 15:07:14 +02:00
d5240d303a
Update docs/features/techdocs/how-to-guides.md
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2024-09-27 14:24:47 +02:00
ef7aee7891
Update docs/features/techdocs/how-to-guides.md
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2024-09-27 14:24:41 +02:00
2f88f88882
docs: remove function call from all backend feature installation instructions
...
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
2024-09-18 15:22:41 +02:00
5bf256adbc
Update per PR review
...
Signed-off-by: Joshua Jung <joshua.p.jung@gmail.com >
2024-09-13 14:45:56 -05:00
b24938cd19
Attempt to fix the url references
...
Signed-off-by: Joshua Jung <joshua.p.jung@gmail.com >
2024-09-13 14:44:13 -05:00
7b882b898f
Fixing issues addressed in PR comments
...
Signed-off-by: Joshua Jung <joshua.p.jung@gmail.com >
2024-09-13 14:44:13 -05:00
8976bc0e94
Adding some documentation on how to use the TechDocs extensions
...
Signed-off-by: Joshua Jung <joshua.p.jung@gmail.com >
2024-09-13 14:44:13 -05:00
1c3e1a88ec
Add examples for creating download links
...
Fixes #17734
Relates #13940 #6069
Signed-off-by: Wedge Jarrad <wedge.jarrad@gmail.com >
2024-08-27 21:52:11 -07:00
765939e8b6
Updated mermaid tutorial to add markdown-inline-mermaid
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2024-08-26 07:49:22 -05:00
4490d733b5
Redirect: Add documentation. Cleanup ( #26041 )
...
* Add documentation. Cleanup. Add guardrail not to redirect to current url.
---------
Signed-off-by: Sydney Achinger <sydneynicoleachinger@spotify.com >
2024-08-15 14:34:15 -04:00
acf9dd349f
Update configuration.md typo
...
Signed-off-by: Lahar Shah <6338800+laharshah@users.noreply.github.com >
2024-08-12 23:58:25 -05:00
201c98bb2c
docs: fix broken link in techdocs configuration
...
Signed-off-by: bioerrorlog <bioerrorlog.contact@gmail.com >
2024-08-08 21:02:07 +09:00
1145181834
Moved from root note to title
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2024-07-13 10:45:17 -05:00
db2bdce0a0
Update discord channel name in README.md
...
Signed-off-by: Piotr Piątkiewicz <piatkiewicz.piotr@gmail.com >
2024-06-24 11:59:31 +02:00
594037ce9b
docs: remove references to containerRunners
...
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com >
2024-06-18 10:57:00 +02:00
395b9738c4
add support for readTree
...
Signed-off-by: Calvin Lee <cjlee@ualberta.ca >
2024-05-29 11:17:09 -06:00
d1e0b2d0d4
Updated the features documents
...
Signed-off-by: Aditya Kumar <aditya.kumar60@infosys.com >
2024-05-17 08:40:28 +05:30
4cca5c2858
Fixed typo in code example for techdocs
...
Signed-off-by: Floww <Floww@users.noreply.github.com >
2024-04-18 21:27:58 +02:00
01950c21a0
Fixed documentation on imports of the plugin-techdocs-backend
...
Signed-off-by: Floww <Floww@users.noreply.github.com >
2024-04-18 21:18:17 +02:00
1e3088c8f2
Updated TechDocs with new backend systems examples
...
Signed-off-by: Andre Wanlin <awanlin@spotify.com >
2024-04-07 12:57:41 -05:00
7b1142251c
feat(integration): Add AWS CodeCommit URL Reader/Integration
...
Signed-off-by: Stijn Brouwers (EISMEA) <stijn@bdcommit.com >
2024-03-24 09:03:34 +01:00
9aac2b0d36
move cwd as the first argument to yarn
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2024-02-04 20:13:00 +01:00
3452e3dd02
Describe how to add standalone techdocs
...
The documentation template doesn't seem to exist any longer.
Add the minimal steps in order to help users get started with
creating a standalone techdocs documentation.
Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com >
Signed-off-by: e553956 <christof.leuenberger@sbb.ch >
Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com >
Fix typo in mcdocs
Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com >
Signed-off-by: e553956 <christof.leuenberger@sbb.ch >
Add requested changes
- Use filename titles for code blocks
- Link to documentation on how to add a component to catalog
- Consistent use of quotes and file endings
Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com >
Signed-off-by: e553956 <christof.leuenberger@sbb.ch >
Add mandatory owner field to example
Signed-off-by: Christof Leuenberger <christof.leuenberger@gmail.com >
Signed-off-by: e553956 <christof.leuenberger@sbb.ch >
Fix prettier issues
Signed-off-by: e553956 <christof.leuenberger@sbb.ch >
2023-12-08 16:39:42 +01:00
06d5cf944a
Merge pull request #21277 from Ninosaurier/doc-update-disable-font
...
Update how-to-guides.md
2023-12-04 12:12:44 +01:00
c8e253a2e8
Update docs/features/techdocs/how-to-guides.md
...
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com >
2023-12-02 06:12:01 -06:00
e9e57add1b
Merge pull request #21403 from hainenber/support-additional-mkdocs-server-cli-params
...
Support additional mkdocs server cli params
2023-11-24 10:31:55 -06:00
716dd37404
fix(pkg/techdocs): correct dirtyreload arg for mkdocs
...
Also correct array-like elements for rest operator
Signed-off-by: hainenber <dotronghai96@gmail.com >
2023-11-21 22:37:02 +07:00
fc92656e42
Merge pull request #20738 from akz08/add-docker-useroptions-bypass
...
Add a way to bypass user modification for TechDocs CLI docs generation in Docker
2023-11-20 17:41:14 +01:00
69b2f7bf3b
fix(techdocs-cli): limit supported mkdocs flags
...
Signed-off-by: hainenber <dotronghai96@gmail.com >
2023-11-20 21:46:41 +07:00
549ca5e3c4
fix(pkg/techdocs-cli): specify new opt
...
Signed-off-by: hainenber <dotronghai96@gmail.com >
2023-11-20 21:23:10 +07:00
286b6f90c3
Update how-to-guides.md
...
Removed "note:". It was a mistake
Signed-off-by: Antonino Provenzano <provenzano.a@gmx.net >
2023-11-17 15:13:31 +01:00
01594ee027
Update docs/features/techdocs/how-to-guides.md
...
Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com >
Signed-off-by: Antonino Provenzano <provenzano.a@gmx.net >
2023-11-17 13:46:12 +01:00
3d61cb0b6a
Merge pull request #20214 from mecseid/feature/implement-gitea-readtree
...
Implement readTree of Gitea provider to support Techdocs
2023-11-15 10:13:24 +01:00
52fff5ed0b
Update how-to-guides.md
...
Added new section in doc, to prevent download of Google fonts
Signed-off-by: Antonino Provenzano <provenzano.a@gmx.net >
2023-11-14 10:49:21 +01:00
20005cf26d
Update techdocs cli docs
...
Signed-off-by: Kamil Zainal <gh@akza.dev >
2023-10-23 15:11:08 +01:00
62735024ad
docs/features/techdocs: wrap file extensions in code blocks
...
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com >
2023-10-17 13:10:14 +02:00
310f6ea5e1
Merge pull request #20229 from Ericsson/plantuml-support-enhancement
...
[TechDocs] Enhance PlantUML support in the techdocs container to include external puml or pu files
2023-10-11 15:08:14 -04:00
60f9546a0d
update cli documentation
...
Signed-off-by: Morgan Bentell <mbentell@spotify.com >
2023-10-06 11:14:45 +02:00
94c762414b
Merge pull request #20109 from kurtaking/remove-alpha-from-import
...
docs: remove alpha from import in techdoc addons
2023-10-05 19:00:22 -04:00
acf7400c5a
[TechDocs] Enhance PlantUML support in the techdocs container to include external puml or pu files
...
Issue Reference #20184
Signed-off-by: Lavanya Sainik <lavanya.sainik@ericsson.com >
2023-09-29 10:42:45 +01:00
870db76a45
Implement readTree of Gitea provider to support Techdocs
...
Signed-off-by: Daniel Mecsei <mecseid@gmail.com >
2023-09-28 09:33:07 +02:00
f6c84edf55
Update configuring-ci-cd.md
...
Signed-off-by: Miguel Alexandre <Symbianx@users.noreply.github.com >
2023-09-26 14:23:47 +02:00
Fredrik Adelöw