-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert "Create branch with no TechDocs"
This reverts commit 5d94b63.
- Loading branch information
1 parent
cf3efff
commit 874b9c0
Showing
12 changed files
with
197 additions
and
125 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# hello |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# This doc is for testing styling problems | ||
|
||
Here is a markdown table: | ||
|
||
| Hello | there | Tilte | | | | ||
|-------------|-----------|--------|---|---| | ||
| Value one | Value two | `code` | | | | ||
| Empty cells | | | | | | ||
| | | | | | | ||
|
||
Code block | ||
|
||
```js | ||
const person = 'one'; | ||
|
||
const func = () => { | ||
return 'this is a func'; | ||
}; | ||
``` | ||
|
||
Headings | ||
|
||
# Heading one | ||
|
||
## Heading 2 | ||
|
||
### heading three | ||
|
||
Version number: 2 | ||
|
||
### heading 4 | ||
|
||
Embedded images | ||
|
||
![expedia group](./the-power-of-platform-logos-updated.png) | ||
|
||
# Graphviz | ||
|
||
This should render a small diagram as long as `graphviz` is available in the environment | ||
where the docs are generated. [MkDocs will use it automatically](https://github.com/backstage/mkdocs-techdocs-core/blob/main/src/core.py#L106). | ||
|
||
{% dot attack_plan.svg | ||
digraph G { | ||
rankdir=LR | ||
Earth [peripheries=2] | ||
Mars | ||
Earth -> Mars | ||
} | ||
%} | ||
|
||
# PlantUML | ||
|
||
```plantuml format="png" classes="uml myDiagram" alt="My super diagram placeholder" title="My super diagram" width="300px" height="300px" | ||
Goofy -> MickeyMouse: calls | ||
Goofy <-- MickeyMouse: responds | ||
``` | ||
|
||
::uml:: format="png" classes="uml myDiagram" alt="My super diagram placeholder" title="My super diagram" width="300px" height="300px" | ||
Goofy -> MickeyMouse: calls | ||
Goofy <-- MickeyMouse: responds | ||
::end-uml:: | ||
|
||
|
||
# Mermaid | ||
This project contains a few lambdas to handle managing installations, github webhook handlers and dishing out tokens to backstage backends. | ||
|
||
```mermaid | ||
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#ff0000'}}}%% | ||
graph TD | ||
A[Christmas] -->|Get money| B(Go shopping) | ||
B --> C{Let me think} | ||
B --> G[/Another/] | ||
C ==>|One| D[Laptop] | ||
C -->|Two| E[iPhone] | ||
C -->|Three| F[fa:fa-car Car] | ||
subgraph section | ||
C | ||
D | ||
E | ||
F | ||
G | ||
end | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Docs for sample-service-1 | ||
|
||
Anyone who has spent more than a month working in a decently sized software engineering department | ||
can tell you the pain of finding documentation. Everyone wishes that great docs for internal | ||
services were the norm but few people are willing to spend the time it takes to make fantastic | ||
docs a reality. | ||
|
||
Even when you do take the time to write good docs, they end up being so difficult to find that you | ||
might as well not have bothered. Motivated teams will create a dedicated website for the software | ||
they have lovingly crafted. But searching for internal software isn’t like searching the open web, | ||
Google doesn’t index your internal subdomains (hopefully!). | ||
|
||
It’s no wonder that software teams struggle to summon the motivation to produce great docs. | ||
They’re hard to write and nobody will see them anyway. | ||
|
||
Backstage solves this problem by co-locating documentation with the service it is for. Write | ||
your docs-as-code in whatever format you like ([MkDocs](https://www.mkdocs.org/) is currently | ||
supported out of the box), publish it where-ever you like, and Backstage will display it in context where it is easier to find. | ||
|
||
test 3 | ||
Build 6 | ||
|
||
<!-- termynal --> | ||
```console | ||
$ show progress | ||
---> 100% | ||
Done! | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Docs for sample-service-1 | ||
|
||
Anyone who has spent more than a month working in a decently sized software engineering department | ||
can tell you the pain of finding documentation. Everyone wishes that great docs for internal | ||
services were the norm but few people are willing to spend the time it takes to make fantastic | ||
docs a reality. | ||
|
||
Even when you do take the time to write good docs, they end up being so difficult to find that you | ||
might as well not have bothered. Motivated teams will create a dedicated website for the software | ||
they have lovingly crafted. But searching for internal software isn’t like searching the open web, | ||
Google doesn’t index your internal subdomains (hopefully!). | ||
|
||
It’s no wonder that software teams struggle to summon the motivation to produce great docs. | ||
They’re hard to write and nobody will see them anyway. | ||
|
||
Backstage solves this problem by co-locating documentation with the service it is for. Write | ||
your docs-as-code in whatever format you like ([MkDocs](https://www.mkdocs.org/) is currently | ||
supported out of the box), publish it whereever you like, and Backstage will display it in context | ||
where it is easy to find. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
## Development | ||
|
||
First add some secrets to the `.env` file in the root. See the `.env.sample` file for suggestions | ||
of required environment variables. | ||
|
||
Then run the software locally like this: | ||
|
||
```shell | ||
yarn start | ||
curl :3000/ | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
```mermaid | ||
%%{init: {'theme': 'forest'}}%% | ||
graph LR | ||
A[Start] --> B{Error?}; | ||
B -->|Yes| C[Hmm...]; | ||
C --> D[Debug]; | ||
D --> B; | ||
B ---->|No| E[Yay!]; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This is a basic runbook |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
This is my testing document | ||
|
||
|
||
```diff | ||
diff --git a/src/components/CallToAction/EmailCaptureForm.js b/src/components/CallToAction/EmailCaptureForm.js index eb154ca..9450b93 100644 | ||
--- a/src/components/CallToAction/EmailCaptureForm.js | ||
+++ b/src/components/CallToAction/EmailCaptureForm.js | ||
@@ -56,7 +56,7 @@ | ||
|
||
const EmailCaptureForm = ({ | ||
<Button | ||
text={buttonText} | ||
disabled={disabled} | ||
- icon={<PaperAirplaneIcon className="h-4 w-4 mr-1" />} | ||
+ prefixIcon={<PaperAirplaneIcon />} | ||
id={buttonId} | ||
fullWidth | ||
color="primary" | ||
``` | ||
|
||
|
||
|
||
<!-- termynal --> | ||
```console | ||
$ show progress | ||
---> 100% | ||
Done! | ||
``` | ||
|
||
|
||
|
||
# Kroki Mermaid Chart: | ||
|
||
```kroki-mermaid | ||
sequenceDiagram | ||
GitLab->>Kroki: Request rendering | ||
Kroki->>Mermaid: Request rendering | ||
Mermaid-->>Kroki: Image | ||
Kroki-->>GitLab: Image | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## Embedded LucidChart Diagram | ||
|
||
<div style="width: 640px; height: 480px; margin: 10px; position: relative;"><iframe allowfullscreen frameborder="0" style="width:640px; height:480px" src="https://lucid.app/documents/embeddedchart/8e8e6dde-33d8-4274-9a31-86e1a6b19cea" id="KS98iepJciPs"></iframe></div> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.