As a devportal maintainer, I would like to ensure there is only one place to edit a programming language specific tutorial, so that I don't edit the wrong thing.
In the original devportal project structure, we had four separate repos. One for the main devportal itself and three for programming language specific tutorials.
The workflow was for a devportal maintainer to edit/create a language specific tutorial in the correct repo, then perform a
rake task within the local copy of the devportal project to scrape the new information from the tutorial's github repo.
The advantage of this was that if someone was reading the tutorials and wanted a copy of the source code examples, they only needed to grab that specific repo with the language they were interested in.
Now we only maintain one repo. A copy of the other trees now live in
/tutorials. This contains a separate tree of tutorials (that can be generated into the hosted tutorials) and source code examples.
Unfortunately, this is confusing. If someone who is unware of the
/tutorials tree, wants to modify one of the generated tutorials, they will simply modify the generated tutorials, skipping the
In order to fix this, the
/tutorials tree should no longer contain any tutorials and only be used for source code examples. This also means that if someone just wants a copy of the language specific source code, they must now clone the entire devportal (or just browse/copy/paste the
/tutorials directly on gitlab).
/tutorialstree no longer contains any tutorials (only retains the related code examples)
raketask along with the custom code to generate these tutorials.
- Ensure all programming language specific tutorials no longer reference the old repo structure.