diff --git a/docs/source/contributeactiondev.rst b/docs/source/contributeactiondev.rst index 1f63ade..0709c8f 100644 --- a/docs/source/contributeactiondev.rst +++ b/docs/source/contributeactiondev.rst @@ -16,7 +16,7 @@ How it works - Study Path - F:\\example - Author Name - test user -- It will create a new branch named ``AuthorName_StudyName`` i.e test_user_test_study in the bot repository ``parteekcoder/concore`` which references the default branch in ``parteekcoder123/concore`` +- It will create a new branch named ``AuthorName_StudyName`` i.e test_user_test_study in the bot repository ``concore-bot/concore-studies`` which references the default branch in ``ControlCore-Project/concore-studies`` .. image:: images/ca-github-branch-ref.png :width: 700 @@ -86,4 +86,16 @@ This token is used to create pull request to upstream repo using bot account as - Click ``Add secret`` +Architecture +------------ +- When ``contribute`` action is triggered it pushes local study to ``concore-bot/concore-studies`` repository + +.. image:: images/ca-architecture.png + :width: 700 + +- After pushing study to Github , it creates a pull reuqest for that study to the ``ControlCore-Porject/concore-studies`` repository + +- Unitl the Pull reuqest is merged or closed this branch serves as staging area + + ``Optional:- If you want to explore why we came up with this approach , please refer https://docs.google.com/document/d/1DdmPO51qOb9OQoiQ4RMH-3O80gxrGWJuHc9QV_AlW0U/edit?usp=sharing`` \ No newline at end of file diff --git a/docs/source/images/ca-architecture.png b/docs/source/images/ca-architecture.png new file mode 100644 index 0000000..0aa3ed7 Binary files /dev/null and b/docs/source/images/ca-architecture.png differ diff --git a/docs/source/images/ca-github-branch-ref.png b/docs/source/images/ca-github-branch-ref.png index 80497e0..04de48c 100644 Binary files a/docs/source/images/ca-github-branch-ref.png and b/docs/source/images/ca-github-branch-ref.png differ