Update readme files

OPM · May 4, 2021 · 50c1f01 · 50c1f01
1 parent d8e9a2d
commit 50c1f01
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,8 @@
 # ResInsight User Documentation
 
+## Edit of the documentation for Python API
+[Edit docs for Python API](docs/README.md)
+
 ## Edit documentation
 Edit documentation in the folder **content**
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,16 @@
 # ResInsight Scripting API - rips
 
-## Please note
-The folder **rips** is a local copy for testing purposes. We need to be able to communicate the generated files to readthedocs in some way.
+## Update procecure on  branch next-major-release
+REQUIRED: Compile ResInsight and make sure the content in folder `ResInsight/GrpcInterface/Python/rips` is up to date
+- Checkout branch next-major-release
+- Delete the copy in `ResInsight-UserDocumentation/docs/rips` 
+- Copy all files from `ResInsight/GrpcInterface/Python/rips` into `ResInsight-UserDocumentation/docs/rips` 
+- Update the example documentation using `ResInsight-UserDocumentation/docs/source/create_python_examples.py`
+- See below for how to create documentation locally
+- Publish to branch next-major-release
+
+## Release of master
+Create pull request from next-major-release to master branch.
 
 ## How to generate documentation locally
 - Install Python 3.x