remove code - docs only module

Author: gilesknap

.gitlab-ci.yml

@@ -13,4 +13,5 @@
     "editor.codeActionsOnSave": {
         "source.organizeImports": true
     },
+    "python.pythonPath": "/home/giles/.local/share/virtualenvs/k8s-epics-docs-jjNZuJbx",
 }

.gitremotes

@@ -2,20 +2,20 @@ Contributing
 ============
 
 Contributions and issues are most welcome! All issues and pull requests are
-handled through github on the `dls_controls repository`_. Also, please check for
+handled through github on the `epics-containers repository`_. Also, please check for
 any existing issues before filing a new one. If you have a great idea but it
 involves big changes, please file a ticket before making a pull request! We
 want to make sure you don't spend your time coding something that might not fit
 the scope of the project.
 
-.. _dls_controls repository: https://github.com/dls-controls/k8s_epics_docs/issues
+.. _epics-containers repository: https://github.com/epics-containers/k8s-epics-docs/issues
 
 Running the tests
 -----------------
 
 To get the source source code and run the unit tests, run::
 
-    $ git clone git://github.com/dls-controls/k8s_epics_docs.git
+    $ git clone git://github.com/epics-containers/k8s-epics-docs.git
     $ cd k8s_epics_docs
     $ pipenv install --dev
     $ pipenv run tests
@@ -27,6 +27,9 @@ same or is improved by a pull request!
 Code Styling
 ------------
 
+This documentation module currently has no code but the style applies to any
+python modules in the epics-containers organization.
+
 The code in this repository conforms to standards set by the following tools:
 
 - black_ for code formatting
@@ -66,13 +69,3 @@ You can build the docs from the project directory by running::
     $ pipenv run docs
     $ firefox build/html/index.html
 
-
-Release Checklist
------------------
-
-Before a new release, please go through the following checklist:
-
-- Choose a new PEP440 compliant release number
-- Git tag the version with a message summarizing the changes
-- Push to github and the actions will make a release on pypi
-- Push to internal gitlab and do a dls-release.py of the tag

.vscode/settings.json

@@ -8,8 +8,8 @@ how it does it, and why people should use it.
 
 ============== ==============================================================
 PyPI           ``pip install k8s_epics_docs``
-Source code    https://github.com/dls-controls/k8s_epics_docs
-Documentation  https://dls-controls.github.io/k8s_epics_docs
+Source code    https://github.com/epics-containers/k8s-epics-docs
+Documentation  https://epics-containers.github.io
 ============== ==============================================================
 
 This is where you should put some images or code snippets that illustrate
@@ -28,22 +28,14 @@ Or if it is a commandline tool then you might put some example commands here::
     k8s_epics_docs person --times=2
 
 
-.. |code_ci| image:: https://github.com/dls-controls/k8s_epics_docs/workflows/Code%20CI/badge.svg?branch=master
-    :target: https://github.com/dls-controls/k8s_epics_docs/actions?query=workflow%3A%22Code+CI%22
+.. |code_ci| image:: https://github.com/epics-containers/k8s-epics-docs/workflows/Code%20CI/badge.svg?branch=master
+    :target: https://github.com/epics-containers/k8s-epics-docs/actions?query=workflow%3A%22Code+CI%22
     :alt: Code CI
 
-.. |docs_ci| image:: https://github.com/dls-controls/k8s_epics_docs/workflows/Docs%20CI/badge.svg?branch=master
-    :target: https://github.com/dls-controls/k8s_epics_docs/actions?query=workflow%3A%22Docs+CI%22
+.. |docs_ci| image:: https://github.com/epics-containers/k8s-epics-docs/workflows/Docs%20CI/badge.svg?branch=master
+    :target: https://github.com/epics-containers/k8s-epics-docs/actions?query=workflow%3A%22Docs+CI%22
     :alt: Docs CI
 
-.. |coverage| image:: https://codecov.io/gh/dls-controls/k8s_epics_docs/branch/master/graph/badge.svg
-    :target: https://codecov.io/gh/dls-controls/k8s_epics_docs
-    :alt: Test Coverage
-
-.. |pypi_version| image:: https://img.shields.io/pypi/v/k8s_epics_docs.svg
-    :target: https://pypi.org/project/k8s_epics_docs
-    :alt: Latest PyPI version
-
 .. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
     :target: https://opensource.org/licenses/Apache-2.0
     :alt: Apache License
@@ -52,4 +44,4 @@ Or if it is a commandline tool then you might put some example commands here::
     Anything below this line is used when viewing README.rst and will be replaced
     when included in index.rst
 
-See https://dls-controls.github.io/k8s_epics_docs for more detailed documentation.
+See https://epics-containers.github.io for more detailed documentation.

CONTRIBUTING.rst

@@ -0,0 +1,60 @@
+.. _CLI:
+
+CLI
+===
+
+The Module k8s-epics-utils provides scripts that simplify common operations
+for deploying and managing IOCs with Kubernetes.
+
+The underlying tools used are:
+
+  - kubectl: https://kubernetes.io/docs/tasks/tools/
+  - helm: https://helm.sh/docs/intro/install/
+
+To enable the scripts you must have helm and kubectl installed and be
+authenticated to your kubernetes cluster. Then source the script:
+
+  -
+
+The k8s-iocs shell function can perform the following opertions. In all cases
+these are simply shortcuts for helm and kubectl commands.
+
+        usage:
+          k8s-ioc <command> <options>
+
+          commands:
+
+            attach <ioc-name>
+                    attach to a running ioc shell
+            delete <ioc-name>
+                    delete all ioc resources except storage
+            deploy <ioc-name> <ioc-version>
+                    deploy an ioc manifest from the beamline helm registry
+            exec <ioc-name>
+                    execute bash in the ioc's container
+            history <ioc-name>
+                    list the history of installed versions of an ioc
+            graylog <ioc-name>
+                    print a URL to get to greylog historical logging for an ioc
+            list <ioc-name> [options]
+                    list k8s resources associtated with ioc-name
+                    -o output formatting e.g. -o name
+            log <ioc-name> [options]
+                    display log of ioc output
+                    -p for previous instance
+                    -f to attach to output stream
+            monitor <beamline>
+                    monitor the status of running IOCs on a beamline
+            ps [<beamline>]
+                    list all running iocs [on beamline]
+            purge
+                    clear the helm local cache
+            restart <ioc-name>
+                    restart a running ioc
+            rollback <ioc-name> <revision>
+                    rollback to a previous revision
+                    (see history command for revision numbers)
+            start <ioc-name>
+                    start a stopped ioc
+            stop  <ioc-name>
+                    stop a deployed ioc

Pipfile.lock

@@ -1,12 +1,6 @@
 Installation Tutorial
 =====================
 
-.. note::
-
-    For installation inside DLS, please see the internal documentation on
-    ``dls-python3`` and ``pipenv``. Although these instructions will work
-    inside DLS, they are intended for external use.
-
 Check your version of python
 ----------------------------
 
@@ -35,7 +29,7 @@ You can now use ``pip`` to install the library::
 If you require a feature that is not currently released you can also install
 from github::
 
-    python3 -m pip install git+git://github.com/dls-controls/k8s_epics_docs.git
+    python3 -m pip install git+git://github.com/epics-containers/k8s-epics-docs.git
 
 The library should now be installed and the commandline interface on your path.
 You can check the version that has been installed by typing::