Created CONTRIBUTE.md #9
Conversation
There was a problem hiding this comment.
I think we do want to shift this back to a README.md because while it includes contribution instructions, it also explains how to use the repository overall.
Some other comments inline based on my testing today on a new VM, and trying to put myself in the shoes of someone completely new to the tool, and perhaps even git.
| @@ -0,0 +1,55 @@ | |||
| This repository is the deployed version of the main repository of Software Discovery Tool as a submodule and the data repository as a sub submodule. | |||
There was a problem hiding this comment.
I think what we want to explain here is bootstrapping. How does someone go from an empty VM, to using this deploy repository? It also may be worthwhile to link to a quick introduction to submodules, since I think most people will not be familiar with them.
So step one may be "Install according to the installation instructions for Ubuntu" but when you get to Step 2 use the following command instead:
sudo git clone --recurse-submodules https://github.com/openmainframeproject/software-discovery-tool-deploy.git
sudo ln -s /opt/software-discovery-tool-deploy/software-discovery-tool/ /opt/software-discovery-tool
And explain that this will check out all submodules, and then create the expected /opt/software-discovery-tool directory.
| The whole SDT deployment is maintained by: | ||
| - [cicd.yml]() workflow | ||
| - [config_build.py]() to create new sections in the distro config file | ||
| - [package_build.py]() to update existing distro files to latest versions |
There was a problem hiding this comment.
For both confg_build.py and package_build.py we need to use the full link to software-discovery-tool/config_build.py since that's where it will actually end up.
| sudo chown -R apache:apache /opt/software-discovery-tool | ||
| sudo -u apache /opt/software-discovery-tool/bin/config_build.py | ||
| sudo apachectl restart | ||
| ``` |
There was a problem hiding this comment.
Since this has the potential to change and we don't want to have to update in 2 places, maybe just link again to cicd.yml instead of including this text inline?
|
|
||
| # Report bugs and issues | ||
| Feel free to add new issues or features that you would like SDT to support. | ||
| Bugs are given high priority since this is an active project used by users of Z Systems. |
There was a problem hiding this comment.
Let's tidy up branding here to say IBM zSystems and LinuxONE 😄
|
|
||
| For deployment improvements, use this repository. | ||
| For new feature request to SDT, use the main repository. | ||
| For new data files request, use the data repository. |
There was a problem hiding this comment.
Let's link to the respective repositories for these last two, since it may not be obvious to a newer user.
|
I have addressed the above changes in this PR |
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
Signed-off-by: rachejazz <[email protected]>
No description provided.