fix: migrate techdocs-container to packages/

packages/techdocs-container/Dockerfile

@@ -0,0 +1,24 @@
+# Copyright 2020 Spotify AB
+#  
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#  
+#     http://www.apache.org/licenses/LICENSE-2.0
+#  
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM python:3.7.7-alpine3.12
+
+RUN apk update && apk --no-cache add gcc musl-dev
+RUN pip install --upgrade pip && pip install mkdocs==1.1.2 mkdocs-material==5.3.2 mkdocs-monorepo-plugin==0.4.5 pymdown-extensions==7.1
+
+ADD ./techdocs-core /techdocs-core
+RUN pip install --no-index /techdocs-core
+
+ENTRYPOINT [ "mkdocs" ]
+

packages/techdocs-container/README.md

@@ -0,0 +1,15 @@
+# MkDocs
+
+Welcome to MkDocs. This is the TechDocs implementation of MkDocs.
+
+**WIP: This is a work in progress. It is not ready for use yet. Follow our progress on [the Backstage Discord](https://discord.gg/MUpMjP2) under #docs-like-code or on [our GitHub Milestone](https://github.com/spotify/backstage/milestone/15).**
+
+## Getting started
+
+```bash
+docker build ./container -t mkdocs-container
+
+docker run -w /content -v $(pwd)/mock-docs:/content -p 8000:8000 -it mkdocs-container serve -a 0.0.0.0:8000
+```
+
+Then open up `http://localhost:8000` on your local machine.

packages/techdocs-container/mock-docs/.gitignore

@@ -0,0 +1 @@
+site/

packages/techdocs-container/mock-docs/docs/index.md

@@ -0,0 +1,32 @@
+## hello mock docs
+
+!!! test
+Testing somethin
+
+Some text about MOCDOC
+
+\*[MOCDOC]: Mock Documentation
+
+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.

packages/techdocs-container/mock-docs/mkdocs.yml

@@ -0,0 +1,8 @@
+site_name: 'mock-docs'
+
+nav: 
+  - Home: index.md
+  - SubDocs: '!include ./sub-docs/mkdocs.yml'
+
+plugins:
+  - techdocs-core

packages/techdocs-container/mock-docs/sub-docs/docs/index.md

@@ -0,0 +1 @@
+### This is an md file in another docs folder using the [MkDocs Monorepo Plugin](https://github.com/spotify/mkdocs-monorepo-plugin)

packages/techdocs-container/mock-docs/sub-docs/mkdocs.yml

@@ -0,0 +1,4 @@
+site_name: subdocs
+
+nav:
+  - Home 2: "index.md"

packages/techdocs-container/techdocs-core/.gitignore

@@ -0,0 +1,2 @@
+.tox
+*.egg-info

packages/techdocs-container/techdocs-core/README.md

@@ -0,0 +1,45 @@
+# techdocs-core
+
+This is the base [Mkdocs](https://mkdocs.org) plugin used when using Mkdocs with Spotify's TechDocs. It is written in Python and packages all of our Mkdocs defaults, such as theming, plugins, etc in a single plugin.
+
+## Usage
+
+**Installation instructions TBD.** We haven't published it to a Python registry yet.
+
+Once you have installed the `mkdocs-techdocs-core` plugin, you'll need to add it to your `mkdocs.yml`.
+
+```yaml
+site_name: Backstage Docs
+
+nav:
+  - Home: index.md
+  - Developing a Plugin: developing-a-plugin.md
+
+plugins:
+  - techdocs-core
+```
+
+## Running Locally
+
+You can install this package locally using `pip` and the `--editable` flag used for making developing Python packages.
+
+```bash
+pip install --editable .
+```
+
+You'll then have the `techdocs-core` package available to use in Mkdocs and `pip` will point the dependency to this folder.
+
+## Running with Docker
+
+In the parent `Dockerfile` we add this folder to the build and install the package locally in the container. In the future, we'll probably move away from this approach and have it download directly from a Python registry (and this folder will publish to one).
+
+See the `README.md` located in the `mkdocs/` folder for more details on how to build and run the Docker container.
+
+## Linting
+
+```bash
+pip install -r requirements.txt
+python -m black src/
+```
+
+**Note:** This will write to all Python files in `src/` with the formatted code. If you would like to only check to see if it passes, simply append the `--check` flag.

packages/techdocs-container/techdocs-core/requirements.txt

@@ -0,0 +1,9 @@
+# The "base" version of the Mkdocs project.
+# Note: if you update this, also update `install_requires` in setup.py
+# https://github.com/mkdocs/mkdocs
+mkdocs==1.1.2
+
+# The linter using for Python
+# Note: This requires Python 3.6+ to run, but can format Python 2 code too.
+# https://github.com/psf/black
+black==19.10b0

packages/techdocs-container/techdocs-core/setup.py

@@ -0,0 +1,48 @@
+"""
+Copyright 2020 Spotify AB
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+from setuptools import setup, find_packages
+
+
+setup(
+    name='mkdocs-techdocs-core',
+    version='0.0.1',
+    description='A Mkdocs package that contains TechDocs defaults',
+    long_description='',
+    keywords='mkdocs',
+    url='https://github.com/spotify/backstage',
+    author='Spotify',
+    author_email='fossboard@spotify.com',
+    license='Apache-2.0',
+    python_requires='>=3.7',
+    install_requires=[
+        'mkdocs>=1.1.2'
+    ],
+    classifiers=[
+        'Development Status :: 1 - Planning',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Information Technology',
+        'License :: OSI Approved :: Apache Software License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3 :: Only',
+        'Programming Language :: Python :: 3.7'
+    ],
+    packages=find_packages(),
+    entry_points={
+        'mkdocs.plugins': [
+            'techdocs-core = src.core:TechDocsCore'
+        ]
+    }
+)

packages/techdocs-container/techdocs-core/src/core.py

@@ -0,0 +1,85 @@
+"""
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+"""
+
+from mkdocs.plugins import BasePlugin, PluginCollection
+from mkdocs.theme import Theme
+
+from mkdocs.contrib.search import SearchPlugin
+
+from mkdocs_monorepo_plugin.plugin import MonorepoPlugin
+
+
+class TechDocsCore(BasePlugin):
+    def on_config(self, config):
+        # Theme
+        config["theme"] = Theme(name="material")
+
+        # Plugins
+        del config["plugins"]["techdocs-core"]
+
+        search_plugin = SearchPlugin()
+        search_plugin.load_config({})
+
+        monorepo_plugin = MonorepoPlugin()
+        monorepo_plugin.load_config({})
+
+        config["plugins"]["search"] = search_plugin
+        config["plugins"]["monorepo"] = monorepo_plugin
+
+        search_plugin = SearchPlugin()
+        search_plugin.load_config({})
+        config["plugins"]["search"] = search_plugin
+
+        # Markdown Extensions
+        config["markdown_extensions"].append("admonition")
+        config["markdown_extensions"].append("abbr")
+        config["markdown_extensions"].append("attr_list")
+        config["markdown_extensions"].append("def_list")
+        config["markdown_extensions"].append("codehilite")
+        config["mdx_configs"]["codehilite"] = {
+            "linenums": True,
+            "guess_lang": False,
+            "pygments_style": "friendly",
+        }
+        config["markdown_extensions"].append("toc")
+        config["mdx_configs"]["toc"] = {
+            "permalink": True,
+        }
+        config["markdown_extensions"].append("footnotes")
+        config["markdown_extensions"].append("markdown.extensions.tables")
+        config["markdown_extensions"].append("pymdownx.betterem")
+        config["mdx_configs"]["pymdownx.betterem"] = {
+            "smart_enable": "all",
+        }
+        config["markdown_extensions"].append("pymdownx.caret")
+        config["markdown_extensions"].append("pymdownx.critic")
+        config["markdown_extensions"].append("pymdownx.details")
+        config["markdown_extensions"].append("pymdownx.emoji")
+        config["mdx_configs"]["pymdownx.emoji"] = {
+            "emoji_generator": "!!python/name:pymdownx.emoji.to_svg",
+        }
+        config["markdown_extensions"].append("pymdownx.inlinehilite")
+        config["markdown_extensions"].append("pymdownx.magiclink")
+        config["markdown_extensions"].append("pymdownx.mark")
+        config["markdown_extensions"].append("pymdownx.smartsymbols")
+        config["markdown_extensions"].append("pymdownx.superfences")
+        config["markdown_extensions"].append("pymdownx.tasklist")
+        config["mdx_configs"]["pymdownx.tasklist"] = {
+            "custom_checkbox": True,
+        }
+        config["markdown_extensions"].append("pymdownx.tilde")
+
+        return config