TechDocs: add docs by default to springboot grpc template (#2288)

* add docs by default to springboot grpc template * delete line from rebase
2020-09-05 20:10:23 +02:00
parent b4ae5c4d19
commit d1fc52d740
3 changed files with 37 additions and 0 deletions
@@ -5,6 +5,7 @@ metadata:
  description: {{cookiecutter.description}}
  annotations:
    github.com/project-slug: {{cookiecutter.storePath}}
+    backstage.io/techdocs-ref: github:https://github.com/{{cookiecutter.storePath}}
 spec:
  type: service
  lifecycle: experimental
@@ -0,0 +1,28 @@
+## {{ cookiecutter.component_id }}
+
+{{ cookiecutter.description }}
+
+## Getting started
+
+Start write your documentation by adding more markdown (.md) files to this folder (/docs) or replace the content in this file.
+
+## Table of Contents
+
+The Table of Contents on the right is generated automatically based on the hierarchy
+of headings. Only use one H1 (`#` in Markdown) per file.
+
+## Site navigation
+
+For new pages to appear in the left hand navigation you need edit the `mkdocs.yml`
+file in root of your repo. The navigation can also link out to other sites.
+
+Alternatively, if there is no `nav` section in `mkdocs.yml`, a navigation section
+will be created for you. However, you will not be able to use alternate titles for
+pages, or include links to other sites.
+
+Note that MkDocs uses `mkdocs.yml`, not `mkdocs.yaml`, although both appear to work.
+See also <https://www.mkdocs.org/user-guide/configuration/>.
+
+## Support
+
+That's it. If you need support, reach out in [#docs-like-code](https://discord.com/channels/687207715902193673/714754240933003266) on Discord.
@@ -0,0 +1,8 @@
+site_name: {{cookiecutter.component_id}}
+site_description: {{cookiecutter.description}}
+
+nav:
+  - Introduction: index.md
+
+plugins:
+  - techdocs-core