-
Notifications
You must be signed in to change notification settings - Fork 4
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
Documentation update #282
Documentation update #282
Conversation
Completed Process Lists Guide. @yousefmoazzam could you please have a look, especially the side output part. If anything does not feel right, grammar or technical. thanks |
Main changes are: - general wording tweaks - add more detail to the pipeline example at the end - reorganise some information in the pipeline example at the end
# Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.
Auto generator of yamls for backends during documentation build
@yousefmoazzam I've added a section on how to Interpret Log File. However, as for our discussion |
@dkazanc Nice, thanks for the explanations of the logfile contents, that's going to be quite useful to reference to people when the release comes! Agreed, once we figure out the meaning/reason behind seeing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall it's looking good to me, I've made a few comments regarding small typos and minor notes on wording in places.
There are sections where I think the wording of larger groups of text could be improved, but that's a bigger job that can be done later, I think this is a decent first pass at getting the bulk of the information in place 🙂
Co-authored-by: Yousef Moazzam <yousefmoazzam@users.noreply.github.com>
Checklist of things to complete the documentation update: