[beam] branch master updated: [BEAM-9782] Update README for instructions on updating katas (#13329)

[lo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

lostluck pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git


The following commit(s) were added to refs/heads/master by this push:
     new 1653a97  [BEAM-9782] Update README for instructions on updating katas (#13329)
1653a97 is described below

commit 1653a977358d4b4933f52d2a4f27d5854f058483
Author: Damon Douglas <da...@users.noreply.github.com>
AuthorDate: Tue Nov 17 15:55:59 2020 -0800

    [BEAM-9782] Update README for instructions on updating katas (#13329)
---
 learning/katas/go/README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/learning/katas/go/README.md b/learning/katas/go/README.md
index 1ec504b..998070f 100644
--- a/learning/katas/go/README.md
+++ b/learning/katas/go/README.md
@@ -27,3 +27,32 @@ Please follow the below steps in order to setup the project properly:
 
 For further instructions on how the GoLand Education works, you can refer
 [here](https://www.jetbrains.com/help/education/educator-start-guide.html?section=Go).
+
+### How to add a new course content
+Since the Stepik course content follows specific rules, it is recommended to create content using the EduTools plugin.
+Please follow the below steps in order to add new course content:
+* Open IntelliJ/GoLand at the learning/katas/go directory and not root of the beam repository.
+* Change the Project dropdown to Course.
+* Right click where new content is to be created and select from the contextual menu
+New lesson, section, or task, where appropriate.
+* When the EduTools plugin creates new content, it will automatically create folders and files.  It is important to
+note that it will not add the ASF license and should be done manually.
+* When creating a new task, the EduTools plugin will create a go.mod in the folder.  It's important to delete this
+as well as change the main folder it creates to cmd.  Please see other tasks in the Go SDK katas for examples
+on the standard structure used throughout the course.
+* It's also important to note that when updating content, the EduTools plugin will update files and also remove
+the ASF license information.  When in doubt, the gradle rat task, at the root of the beam repository, can
+uncover any files with missing licenses.
+
+### Updating Stepik
+To update a Stepik course, one must be assigned as an instructor.
+* Open IntelliJ/GoLand at the learning/katas/go directory and not root of the beam repository.
+* Change the Project dropdown to Course.
+* Right click Beam Katas - Go (Course Creation) and find Course Creator in the context menu.
+* Click "Update course on Stepik"
+* The EduTools plugin will update and/or create `*-remote-info.yaml` files.  Commit any
+of these changed or new files to the beam repository.
+
+### Tracking the Go SDK Code Katas project
+
+[BEAM-9676](https://issues.apache.org/jira/browse/BEAM-9676) tracks the Go SDK Code Katas project.