Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Moban.rst: Doc on Moban Usage in Coala #601

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Moban.rst: Doc on Moban Usage in Coala #601

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5090e35
update index, add sidebar option
Lancasterwu Mar 9, 2020
b9ce174
update basic description of the moban page
Lancasterwu Mar 9, 2020
23ad055
finished an outline for documentation
Lancasterwu Mar 9, 2020
027b9d3
Update Moban.rst
Lancasterwu Mar 9, 2020
1e9f79e
Update Moban.rst
Lancasterwu Mar 9, 2020
6ccbe5e
Structure of Moban
Mar 11, 2020
2b186f5
Structure of Moban
Mar 11, 2020
52bc667
Add testing documentation in Moban.rst
stephensonc Mar 11, 2020
e39a9a6
Explaining connections to Coala
reibelj Mar 12, 2020
a3fce56
Fixed an error of displaying structure
Lancasterwu Mar 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Explaining connections to Coala
  • Loading branch information
@reibelj
reibelj committed Mar 12, 2020
commit e39a9a6ec48767ebffc51097d406d7573af97501
3 changes: 1 addition & 2 deletions Users/Moban.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,5 +87,4 @@ of moban.

Why Moban, and How?
-----------------

After Jon's discovery
Moban is used as a dependency within Coala. The main purpose and functionality of Moban within Coala is the modification of configuration files within the repository. Specifically, it works within the configuration file in which text is statically generated based on a template and converted into another file type to be used for further configuration and integration. In the case of Coala, Moban is ran on the travis.yml file. The text is statically generated and rendered into a jinja template. This template is stored within the template directory of Moban. A new file "Moban.out" is created and sent to a new .jj2 file and then stored within the the Moban.dt directory. It appears that the functions within travis.yml are created into separate .jj2 files and passed into the new configuration file. From this directory, the created files are then called by the moban.yml file in order to act as another level of configuration and integration for the tool. This integration can run varying checks compared to the Travis CI build allowing for a more robust integration sequence. Taking this into account, there are no impacts or changes made to the run process of Coala including; input, output, and user interaction. The tool has the ability to run without usage of Moban. Knowing this it may be wondered as to why it is being used. From the outside it appears confusing and irrelevant, but taking what is known and understanding the connections between the tools is helpful. The Moban tool is simply being utilized to provide another layer of configuration and integration to Coala. The final reasoning on why it is used this way is left to the developers and contributors to explain.