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.

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

Create diff patch workflows for docs and tutorial changes #2799

Open
butlerpd opened this issue Feb 4, 2024 · 0 comments
Open

Create diff patch workflows for docs and tutorial changes #2799

butlerpd opened this issue Feb 4, 2024 · 0 comments
Labels
Enhancement Feature requests and/or general improvements

Comments

@butlerpd
Copy link
Member

butlerpd commented Feb 4, 2024

Is your feature request related to a problem? Please describe.
As we try to lower the contribution barriers for non-coders to provide and edit documentation and tutorials etc. outside of the git environment, we need to provide a streamlined workflow that allows the changes to be submitted back to the repo, including the usual review step.

Describe the solution you'd like
What is needed is a streamlined (simple) method that creates a branch in the repo, makes a diff with the files currently in the repo, creates a patch from that diff, and applies the patch back to the branch in the repo. A method to automatically generate a pull request would also be helpful.

Implementation idea:
In order to get the files created on a random computer by someone with no github account into the SasView github system we could create a simplified webapp like the marketplace where users log in and upload their new file along with the answers to some required questions and the webapp could do the rest. The required questions would include anything we think we need for author verification or security if any?

For those items created from within the SasView GUI (e.g. the documentation) one could add a "start submission process" button to the GUI which launches the above mentioned webapp and automatically uploads the file in question but requiring the user to enter any other required information. The issue here is that it may be a bit complicated for them to go hunt down the changed file in the SasView tree structure?

This should work as long as changes are infrequent enough that we don't run into merge conflicts. Those could become a mess, but requiring the email address of the submitter could help?

Describe alternatives you've considered
Have not come up with any

Additional context
This has been a long running issue already for the tutorials repo and there may be future use cases for this as well.

Example of the issue for the Tutorial repo are SasView/tutorials#14 and SasView/tutorials#15 which updates an existing tutorial with minor changes. Those tutorials are however are written in Libre Office and the update is currently done by swapping the file out making the diff the entire file. The format is fodt which was chosen specifically to be more compatible with git than ppt for example but that feature is not currently used. Thus reviewing the pull request requires reviewing the entire document carefully. It would be very helpful to be able to look at the changes sepearately.

@butlerpd butlerpd added the Enhancement Feature requests and/or general improvements label Feb 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement Feature requests and/or general improvements
Projects
None yet
Development

No branches or pull requests

1 participant