search

openmainframeproject / software-discovery-tool-deploy

View the live deployed version of SDT maintained by OMP
http://sdt.openmainframeproject.org/sdt/
Apache License 2.0
0 stars 7 forks source link

Document usage in README.md #2

Open pleia2 opened 3 years ago

pleia2 commented 3 years ago

This repository shouldn't need much documentation, because we're using it for our own deployment for the Open Mainframe Project, but it should have a minimal amount so that 1) future contributors to the tool can maintain it and 2) others who wish to use GitHub for deploying are able to easily fork this repository and make necessary changes to use it themselves. So we want to make sure the documentation covers these two cases.

pleia2 commented 2 years ago

@rachejazz I think this is where we'll want to clearly define the requirements for deployment, since there is some pre-work to be done to set up the server, like installing Apache and creating the sdt user, setting up ssh keys for inclusion in GitHub Secrets.

We should also document how it's updating the sources (both from SDT and PDS).

rachejazz commented 2 years ago

Ah great, so what do you suggest, make a new md file or improve the old Installation.md file?

pleia2 commented 2 years ago

The installation docs leave a bit of flexibility to the user, but it's all valuable, so I'd link to the Installation docs over in the main SDT repo, and then write some instructions specific to using a -deploy repository on GitHub. Essentially, assume the users are creating a fork of this repository for their own use, and describe how to maintain the submodules interaction, and that they should create an sdt user on their server and get the SSH credentials to put in GitHub Secrets. And whatever else :smile:

rachejazz commented 2 years ago

Alright, that works. Will get this done by the weekend?

Also, I have tried updating the packages lists throughout September and October, I saw no upstream changes for s390x packages. Turns out we don't need to follow a "once a month" pull afterall!

pleia2 commented 2 years ago

Whenever you get to it! This was just on my list for a follow-up.

rachejazz commented 2 years ago

@pleia2 can you verify if this defines all the required points? https://gist.github.com/rachejazz/de39c09612788635d5d0f491dcf8571a I have named it CONTRIBUTE.md but README.md also works i beleive. I'll keep on adding whatever is necessary then will finally update the readme file