forked from DevFW-CICD/edp-doc
feat(backstage-doc): added techdoc skeleton occording to https://backstage.io/docs/features/techdocs/creating-and-publishing
This commit is contained in:
parent
3411feace7
commit
31f3f9f65d
1 changed files with 133 additions and 0 deletions
133
docs/index.md
Normal file
133
docs/index.md
Normal file
|
@ -0,0 +1,133 @@
|
||||||
|
# Doc
|
||||||
|
|
||||||
|
```plantuml
|
||||||
|
@startuml
|
||||||
|
title Login Sequence
|
||||||
|
ComponentA->ComponentB: Login Request
|
||||||
|
note right of ComponentB: ComponentB logs message
|
||||||
|
ComponentB->ComponentA: Login Response
|
||||||
|
@enduml
|
||||||
|
```
|
||||||
|
|
||||||
|
## hello mock docs
|
||||||
|
|
||||||
|
!!! test
|
||||||
|
Testing something
|
||||||
|
|
||||||
|
Abbreviations:
|
||||||
|
Some text about MOCDOC
|
||||||
|
|
||||||
|
This is a paragraph.
|
||||||
|
{: #test_id .test_class }
|
||||||
|
|
||||||
|
Apple
|
||||||
|
: Pomaceous fruit of plants of the genus Malus in
|
||||||
|
the family Rosaceae.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import { test } from 'something';
|
||||||
|
|
||||||
|
const addThingToThing = (a, b) a + b;
|
||||||
|
```
|
||||||
|
|
||||||
|
- [abc](#abc)
|
||||||
|
- [xyz](#xyz)
|
||||||
|
|
||||||
|
## abc
|
||||||
|
|
||||||
|
This is a b c.
|
||||||
|
|
||||||
|
## xyz
|
||||||
|
|
||||||
|
This is x y z.
|
||||||
|
|
||||||
|
# The attack plan
|
||||||
|
|
||||||
|
{% dot attack_plan.svg
|
||||||
|
digraph G {
|
||||||
|
rankdir=LR
|
||||||
|
Earth [peripheries=2]
|
||||||
|
Mars
|
||||||
|
Earth -> Mars
|
||||||
|
}
|
||||||
|
%}
|
||||||
|
|
||||||
|
```graphviz dot attack_plan.svg
|
||||||
|
digraph G {
|
||||||
|
rankdir=LR
|
||||||
|
Earth [peripheries=2]
|
||||||
|
Mars
|
||||||
|
Earth -> Mars
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
# PlantUML Samples
|
||||||
|
|
||||||
|
```plantuml classes="uml myDiagram" alt="Diagram placeholder" title="My diagram"
|
||||||
|
@startuml
|
||||||
|
Goofy -> MickeyMouse: calls
|
||||||
|
Goofy <-- MickeyMouse: responds
|
||||||
|
@enduml
|
||||||
|
```
|
||||||
|
|
||||||
|
# Emojis
|
||||||
|
|
||||||
|
:bulb: :smile:
|
||||||
|
|
||||||
|
# Code blocks
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import { test } from 'something';
|
||||||
|
|
||||||
|
const addThingToThing = (a, b) a + b;
|
||||||
|
```
|
||||||
|
|
||||||
|
# Grouped Code blocks
|
||||||
|
|
||||||
|
=== "JavaScript"
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import { test } from 'something';
|
||||||
|
|
||||||
|
const addThingToThing = (a, b) a + b;
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "Java"
|
||||||
|
|
||||||
|
```java
|
||||||
|
public void function() {
|
||||||
|
test();
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```java tab="java"
|
||||||
|
public void function() {
|
||||||
|
test();
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```java tab="java 2"
|
||||||
|
public void function() {
|
||||||
|
test();
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
# MDX truly sane lists
|
||||||
|
|
||||||
|
- attributes
|
||||||
|
|
||||||
|
- customer
|
||||||
|
- first_name
|
||||||
|
- test
|
||||||
|
- family_name
|
||||||
|
- email
|
||||||
|
- person
|
||||||
|
- first_name
|
||||||
|
- family_name
|
||||||
|
- birth_date
|
||||||
|
- subscription_id
|
||||||
|
|
||||||
|
- request
|
||||||
|
|
||||||
|
<!-- prettier-ignore -->
|
||||||
|
*[MOCDOC]: Mock Documentation
|
Loading…
Reference in a new issue