feat(techdocs-core): Adds skeleton of techdocs-core defaults

plugins/techdocs/mkdocs/README.md

@@ -9,5 +9,5 @@ Welcome to MkDocs. This is the TechDocs implementation of MkDocs.
 ```
   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 --theme material
+  docker run -w /content -v $(pwd)/mock-docs:/content -p 8000:8000 -it mkdocs-container serve -a 0.0.0.0:8000
 ```

plugins/techdocs/mkdocs/container/Dockerfile

@@ -3,5 +3,8 @@ FROM python:3.7.7-alpine3.12
 RUN apk update && apk --no-cache add gcc musl-dev
 RUN pip install mkdocs==1.1.2 mkdocs-material==5.3.2
 
+ADD ./techdocs-core /techdocs-core
+RUN pip install --no-index /techdocs-core
+
 ENTRYPOINT [ "mkdocs" ]
 

plugins/techdocs/mkdocs/container/techdocs-core/.gitignore

@@ -0,0 +1,117 @@
+*~
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

plugins/techdocs/mkdocs/container/techdocs-core/requirements.txt

@@ -0,0 +1 @@
+mkdocs==1.1.2

plugins/techdocs/mkdocs/container/techdocs-core/setup.py

@@ -0,0 +1,33 @@
+from setuptools import setup, find_packages
+
+
+setup(
+    name='mkdocs-techdocs-core',
+    version='0.1.0',
+    description='A Mkdocs package that contains TechDocs defaults',
+    long_description='',
+    keywords='mkdocs',
+    url='https://github.com/spotify/backstage',
+    author='Spotify',
+    author_email='foss@spotify.com',
+    license='Apache-2.0',
+    python_requires='>=3.7,<3.8',
+    install_requires=[
+        'mkdocs>=1.1.2'
+    ],
+    classifiers=[
+        # 'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Information Technology',
+        'License :: OSI Approved :: Apache 2.0',
+        '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'
+        ]
+    }
+)

plugins/techdocs/mkdocs/container/techdocs-core/src/core.py

@@ -0,0 +1,19 @@
+from mkdocs.plugins import BasePlugin, PluginCollection
+from mkdocs.theme import Theme
+
+from mkdocs.contrib.search import SearchPlugin
+
+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({})
+       config['plugins']['search'] = search_plugin
+
+       return config
+

plugins/techdocs/mkdocs/mock-docs/.gitignore

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

plugins/techdocs/mkdocs/mock-docs/mkdocs.yml

@@ -2,3 +2,6 @@ site_name: 'mock-docs'
 
 nav: 
   - Home: index.md
+
+plugins:
+  - techdocs-core