Here is a draft of GIN Usage guidelines based on my experience with GIN and discussions with Achilleas. Could you have a look and post your comments below? You can also directly edit the raw file as I have added you as collaborators.
@achilleas, @cgars, @twachtler, @msonntag
[Here](https://web.gin.g-node.org/ajkumaraswamy/gin-usage/src/master/GinUsage.md) is a draft of GIN Usage guidelines based on my experience with GIN and discussions with Achilleas. Could you have a look and post your comments below? You can also directly edit [the raw file](https://web.gin.g-node.org/ajkumaraswamy/gin-usage/src/master/GinUsage.md) as I have added you as collaborators.
I tried to fix the links in "Contents", a few work now. However, some still don't work. Additionally, some links elsewhere in the text also do not work. Could you take a look at that?
I tried to fix the links in "Contents", a few work now. However, some still don't work. Additionally, some links elsewhere in the text also do not work. Could you take a look at that?
I fixed the anchor links and they all work properly now.
Just to note: You can get the name of each anchor by hovering over the header text and then clicking (or just hovering) over the link icon that appears to the left of each one. The anchor is the name of the section but with all special characters stripped out (parens, slashes, etc).
I fixed the anchor links and they all work properly now.
Just to note: You can get the name of each anchor by hovering over the header text and then clicking (or just hovering) over the link icon that appears to the left of each one. The anchor is the name of the section but with all special characters stripped out (parens, slashes, etc).
Would it be a good idea to add a webpage only usage of GIN? I was talking to an experimental biologist collaborator. Such a guide would be useful for cases where we one has to request some editing from a "non command line" user.
Would it be a good idea to add a webpage only usage of GIN? I was talking to an experimental biologist collaborator. Such a guide would be useful for cases where we one has to request some editing from a "non command line" user.
Yeah and website usage should be pretty straightforward for most people. I guess we could focus on the repo creation and file upload part.
Could we do a full on step-by-step guide with screenshots or is that too much?
Yeah and website usage should be pretty straightforward for most people. I guess we could focus on the repo creation and file upload part.
Could we do a full on step-by-step guide with screenshots or is that too much?
@cgars: Thanks
@achilleas: I agree. We could also mention editing text files and adding appropriate comments before 'saving' (committing) the changes.
Another thing, I noticed it is not possible to edit a non-text file. However, it might be interesting to add a functionality to replace a non-text file by uploading a changed file and then adding a commit message and committing it. This would be especially useful for small non-text files, like excel files storing metadata. Such a feature would enable quick editing on the go, without needing to download the client.
@cgars: Thanks
@achilleas: I agree. We could also mention editing text files and adding appropriate comments before 'saving' (committing) the changes.
Another thing, I noticed it is not possible to edit a non-text file. However, it might be interesting to add a functionality to replace a non-text file by uploading a changed file and then adding a commit message and committing it. This would be especially useful for small non-text files, like excel files storing metadata. Such a feature would enable quick editing on the go, without needing to download the client.
Louis Longin
@achilleas, @cgars, @twachtler, @msonntag
Here is a draft of GIN Usage guidelines based on my experience with GIN and discussions with Achilleas. Could you have a look and post your comments below? You can also directly edit the raw file as I have added you as collaborators.
Hey Ajay
thank you a lot. This is a great walk through and i guess we will be integrating it into the wiki soon.
Best Christian
The usage workflows have been cleaned up a bit. Should we merge them now or do we want to add more?
I tried to fix the links in "Contents", a few work now. However, some still don't work. Additionally, some links elsewhere in the text also do not work. Could you take a look at that?
I fixed the anchor links and they all work properly now. Just to note: You can get the name of each anchor by hovering over the header text and then clicking (or just hovering) over the link icon that appears to the left of each one. The anchor is the name of the section but with all special characters stripped out (parens, slashes, etc).
That's great. Thanks for fixing and the tips! I am happy with the current version.
Would it be a good idea to add a webpage only usage of GIN? I was talking to an experimental biologist collaborator. Such a guide would be useful for cases where we one has to request some editing from a "non command line" user.
Sure. However as you kind of point out, thats probably a very limited use case. Ill, open an issue and appoint someone.
Yeah and website usage should be pretty straightforward for most people. I guess we could focus on the repo creation and file upload part. Could we do a full on step-by-step guide with screenshots or is that too much?
@cgars: Thanks @achilleas: I agree. We could also mention editing text files and adding appropriate comments before 'saving' (committing) the changes.
Another thing, I noticed it is not possible to edit a non-text file. However, it might be interesting to add a functionality to replace a non-text file by uploading a changed file and then adding a commit message and committing it. This would be especially useful for small non-text files, like excel files storing metadata. Such a feature would enable quick editing on the go, without needing to download the client.
This already works afaik
I couldn't figure out how to replace a non-text file from webpage, add a comment and commit it. Could you tell me how?
Upload File(might take some time for big repos)Screenshots illustrating the GIN Usage guidelines should also be created