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

Can repository informations be provided via environment variables? #17

Closed
sroertgen opened this issue Jan 30, 2024 · 8 comments · Fixed by #20
Closed

Can repository informations be provided via environment variables? #17

sroertgen opened this issue Jan 30, 2024 · 8 comments · Fixed by #20
Assignees

Comments

@sroertgen
Copy link
Contributor

No description provided.

@sroertgen sroertgen self-assigned this Jan 30, 2024
@sroertgen sroertgen added this to SkoHub Jan 30, 2024
@github-project-automation github-project-automation bot moved this to Backlog in SkoHub Jan 30, 2024
@acka47 acka47 moved this from Backlog to Ready in SkoHub Feb 19, 2024
@sroertgen sroertgen moved this from Ready to Working in SkoHub Mar 4, 2024
@sroertgen
Copy link
Contributor Author

sroertgen added a commit that referenced this issue Mar 13, 2024
@sroertgen sroertgen moved this from Working to Review in SkoHub Mar 13, 2024
sroertgen added a commit that referenced this issue Mar 14, 2024
sroertgen added a commit that referenced this issue Mar 14, 2024
@sroertgen sroertgen linked a pull request Mar 14, 2024 that will close this issue
sroertgen added a commit that referenced this issue Mar 14, 2024
* Test use of env variables

* Add BASEURL info with env variable

* Adjust README for new workflow #17

* Add info to activate GitHub Actions #17

* Remove hint to change something. Not necessary any more #17

* Update README #17

* Reset vocabulary to default state #17
@github-project-automation github-project-automation bot moved this from Review to Done in SkoHub Mar 14, 2024
@sroertgen sroertgen reopened this Mar 14, 2024
@sroertgen
Copy link
Contributor Author

@acka47 I merged this into main.

Feel free to test.

Consider the following scenarios:

  • someone forks this repo with the same name and modifies some vocabularies.
  • someone changes the name of the repo when forking and modifies some vocabularies.

Both cases should work.

We use this issue to discuss further and will close it when everything is ok.

@sroertgen sroertgen assigned acka47 and unassigned sroertgen Mar 14, 2024
@sroertgen sroertgen moved this from Done to Review in SkoHub Mar 14, 2024
@acka47
Copy link
Member

acka47 commented Mar 14, 2024

This looks really nice. I have tested it.

someone forks this repo with the same name and modifies some vocabularies.

I have checked this and it works.

someone changes the name of the repo when forking and modifies some vocabularies.

I also did that and it works, see https://github.com/acka47test/test-vocabs

However, with each test, I ran into some problems and it did not work directly (which was my fault).

I suggest the following:

  • Shorten the "Usage" list, especially bullet point 3 with the steps you have to follow to make everything work directly.
  • Add a troubleshooting paragraph where the most common problems (gh-pages not forked, branch not set for pages, Actions not activated) are adressed.
  • We should also think about adding screenshots to the usage paragraph.

sroertgen added a commit that referenced this issue Mar 14, 2024
sroertgen added a commit that referenced this issue Mar 14, 2024
@sroertgen
Copy link
Contributor Author

I shortened the usage section and added a troubleshooting section.

Regarding screenshots I'm hesitating since they blow up the size of the git repo.
Maybe we should put them somewhere different (like a tutorials repository) and just link them from there?

@acka47
Copy link
Member

acka47 commented Mar 14, 2024

I shortened the usage section and added a troubleshooting section.

This is much better. I tried to make it even a bit more concise with #23 .

Regarding screenshots I'm hesitating since they blow up the size of the git repo.
Maybe we should put them somewhere different (like a tutorials repository) and just link them from there?

I agree, this make sense and we already discussed this approach yesterday, see skohub-io/skohub.io#19 (comment)

@acka47 acka47 removed their assignment Mar 14, 2024
acka47 added a commit that referenced this issue Mar 14, 2024
sroertgen pushed a commit that referenced this issue Mar 14, 2024
* Further simplify the usage paragraph (#17)

* Fix phrasing (#17)
@sroertgen
Copy link
Contributor Author

sroertgen commented Mar 14, 2024

@acka47 so then I will close this now and I will make a new issue to add screenshots to the usage section. ok?

@acka47
Copy link
Member

acka47 commented Mar 14, 2024

so then I will close this now and I will make a new issue to add screenshots to the usage section. ok?

I think, we should just keep this in mind for implementing skohub-io/skohub.io#19 (which will be done in a different repo than this, I think).

@acka47
Copy link
Member

acka47 commented Mar 14, 2024

I think, we should just keep this in mind for implementing skohub-io/skohub.io#19 (which will be done in a different repo than this, I think).

I've added it in skohub-io/skohub.io#19 (comment), feel free to close this one now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants