Skip to content
This repository has been archived by the owner on Feb 27, 2024. It is now read-only.

Guinea-pigging MRGT - Clarifications needed #27

Closed
4 tasks done
RieksJ opened this issue Oct 11, 2022 · 6 comments
Closed
4 tasks done

Guinea-pigging MRGT - Clarifications needed #27

RieksJ opened this issue Oct 11, 2022 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@RieksJ
Copy link
Contributor

RieksJ commented Oct 11, 2022

The following texts are too unclear for me to understand:

  • line 76 says: "Terminologies are developed and shared on GitHub". Does this mean that all curated texts are drawn from a github repo (implying that I first need to commit stuff and sync repos before I can generate an MRG)? Or only the stuff that is imported from other scopedirs?

  • Please specify the permissions that the github access token must come with (e.g. all repo access?) An image could be helpful

  • lines 126-131 document the configuration, but it is not explicit enough (for me). Please provide concrete examples for all the stuff within < and > (that of course won't work, but they give me an idea of what it actually is I need to fill in there). I added some examples, but @sih: can you check and make sure they're ok?.

  • further down I noticed that http://localhost:8083 doesn't work whereas http://localhost:8083/ctwg/mrg does. It should have been a different issue, but to not get things too complicated, here's my request: Can you make http://localhost:8083 work as if http://localhost:8083/ctwg/mrg were typed?

@RieksJ RieksJ added the documentation Improvements or additions to documentation label Oct 11, 2022
RieksJ added a commit that referenced this issue Oct 11, 2022
@sih
Copy link
Collaborator

sih commented Oct 11, 2022

Just to let you know, I'm off work for a few days so won't be able to get to this until the end of the week

@RieksJ

This comment was marked as resolved.

@RieksJ

This comment was marked as resolved.

@RieksJ
Copy link
Contributor Author

RieksJ commented Oct 11, 2022

Ah. Got it (I hadn't read the documentation): I need to go to http://localhost:8083/ctwg/mrg instead of http://localhost:8083. Would it be possible to have http://localhost:8083 work also?

sih added a commit that referenced this issue Oct 13, 2022
#28

Update documentation following review comments
Add a better error message when the user specifies the wrong directory, i.e.  a directory with no SAF
Add an image to show the Personal Access Token privileges to choose
Make changes to cater for latest incarnation of terms

Signed-off-by: Sid Haniff <syed_haniff@hotmail.com>
@sih
Copy link
Collaborator

sih commented Oct 13, 2022

The following texts are too unclear for me to understand:

  • line 76 says: "Terminologies are developed and shared on GitHub". Does this mean that all curated texts are drawn from a github repo (implying that I first need to commit stuff and sync repos before I can generate an MRG)? Or only the stuff that is imported from other scopedirs?

Yes, this is stated in the first sentence of the Generating a machine-readable glossary section, namely: "In order to generate the MRG you will have a scope repository on GitHub containing the Scope
Administration File (SAF) and the curated texts."

  • Please specify the permissions that the github access token must come with (e.g. all repo access?) An image could be helpful

Yes good idea have added an image

  • lines 126-131 document the configuration, but it is not explicit enough (for me). Please provide concrete examples for all the stuff within < and > (that of course won't work, but they give me an idea of what it actually is I need to fill in there). I added some examples, but @sih: can you check and make sure they're ok?.

I have made some minor changes to your texts

  • further down I noticed that http://localhost:8083 doesn't work whereas http://localhost:8083/ctwg/mrg does. It should have been a different issue, but to not get things too complicated, here's my request: Can you make http://localhost:8083 work as if http://localhost:8083/ctwg/mrg were typed?

Correct it doesn't work. I was going to reserve the default address for an HTML version of the instructions once they are stable enough (i.e. I don't have to maintain a markdown and an HTML copy). I think this is actually a better idea than just going straight to the form. The form can just be a link from that page.

sih added a commit that referenced this issue Oct 13, 2022
#28

Update documentation following review comments
Add a better error message when the user specifies the wrong directory, i.e.  a directory with no SAF
Add an image to show the Personal Access Token privileges to choose
Make changes to cater for latest incarnation of terms

Signed-off-by: Sid Haniff <syed_haniff@hotmail.com>

Signed-off-by: Sid Haniff <syed_haniff@hotmail.com>
sih added a commit that referenced this issue Oct 13, 2022
Add missing image

Signed-off-by: Sid Haniff <syed_haniff@hotmail.com>
@sih sih assigned RieksJ and unassigned sih Oct 14, 2022
@RieksJ
Copy link
Contributor Author

RieksJ commented Oct 14, 2022

closing the issue, remembering the last point to be done as #34

@RieksJ RieksJ closed this as completed Oct 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants