Tags and Releases Documentation #106

Merged
n merged 19 commits from :master into tags-and-releases 1 year ago
There is no content yet.
Poster

#88

#88
Poster
@ivan-paleo
unbeatable-101 started working 1 year ago

It looks interesting! Let me know when you're finished and I'll try to give you some feedback.

It looks interesting! Let me know when you're finished and I'll try to give you some feedback.
unbeatable-101 stopped working 1 year ago
19h 46min 7s
unbeatable-101 started working 1 year ago
unbeatable-101 cancelled time tracking 1 year ago
Poster

@ivan-paleo I think it is done.

@ivan-paleo I think it is done.
ivan-paleo requested changes 1 year ago
ivan-paleo left a comment

Thank you for the PR!

I think it would be better if you could provide screenshots using the "knut" account, and additionally providing webP images. See the Contributor FAQ for details.

See other comments below.

order: 60
---
# What are tags?
Poster

To me, it is not clear what the difference between tags and releases is. I'm a newbie on that, but the documentation is there so that newbies like me understand these concepts :)
Additionally, the page on Codeberg is called "releases" and there you can create "new releases". Tags are mentioned in the next step only.
Could you please elaborate and, if necessary, adapt the rest of the text?

To me, it is not clear what the difference between tags and releases is. I'm a newbie on that, but the documentation is there so that newbies like me understand these concepts :) Additionally, the page on Codeberg is called "releases" and there you can create "new releases". Tags are mentioned in the next step only. Could you please elaborate and, if necessary, adapt the rest of the text?
Poster

I updated it, is it easy to understand now?

I updated it, is it easy to understand now?
Poster

Yes, it's much better.
But two more details:

  • You write that "tags... are usally paired with a compiled binary file", but later that "releases are tags acompanied with a binary file". That's confusing because the first sentence then means that you are actually talking about releases, in the section about tags!
  • Do not forget the period at the end of the sentence in the section "Wait, what is the difference between tags and releases?"
Yes, it's much better. But two more details: * You write that "tags... are usally paired with a compiled binary file", but later that "releases are tags acompanied with a binary file". That's confusing because the first sentence then means that you are actually talking about releases, in the section about tags! * Do not forget the period at the end of the sentence in the section "Wait, what is the difference between tags and releases?"
<img src="/assets/images/git/using-tags/clicking-a-tag.gif"/>
<picture/>
## Making new tags
Poster

I think it makes more sense to first explain how to create tags/releases, and then to explain how to find and view them.

I think it makes more sense to first explain how to create tags/releases, and then to explain how to find and view them.
unbeatable-101 marked this conversation as resolved
See [Creating a release](/collaborating/citable-code/#creating-a-release)
### Git<br>
To create a tag using git, enter `git tag -a <version number here> -m "<my tag name>"`. It is good practice to prefix the version number with a `v` (e.g. `v1.2.3`) and to use [semantic versioning](https://semver.org/).
Poster

I believe it would be better in terms of style to provide code in a code block:

git tag -a <version number here> -m "<my tag name>"
I believe it would be better in terms of style to provide code in a code block: ```bash git tag -a <version number here> -m "<my tag name>" ```
unbeatable-101 marked this conversation as resolved
Poster

@ivan-paleo, I can't access https://codeberg-test.org, could you do the screenshots?

@ivan-paleo, I can't access https://codeberg-test.org, could you do the screenshots?

@ivan-paleo, I can't access https://codeberg-test.org, could you do the screenshots?

@n or @hw: can we give @unbeatable-101 access to it, or allow him to do screenshots?

> @ivan-paleo, I can't access https://codeberg-test.org, could you do the screenshots? @n or @hw: can we give @unbeatable-101 access to it, or allow him to do screenshots?
unbeatable-101 requested review from ivan-paleo 1 year ago
Poster

I get this when I try to visit

I get this when I try to visit
hw commented 1 year ago
Owner

We have redirected DNS for migration tests, https://codeberg-test.org will be back soon. Sorry for disruption

We have redirected DNS for migration tests, https://codeberg-test.org will be back soon. Sorry for disruption
hw commented 1 year ago
Owner

back online (dns propagation might take a bit)

back online (dns propagation might take a bit)
Poster

OK, the site is up, but how do I use the knut account? Or should I just use TODO SCREENSHOT [of foo] so you guys can do it?

OK, the site is up, but how do I use the knut account? Or should I just use `TODO SCREENSHOT [of foo]` so you guys can do it?
Poster

Here are the screenshots I took for reference.

Here are the screenshots I took for reference.

Thank you @unbeatable-101, it looks all good from my side. I'm not sure I'll have the time this or next week to do the screenshots. If you don't get access to the knut account in the meantime (I'm not the one deciding), I'll do them in two weeks.

We also need someone else to review it. @n maybe? I don't really know who's in the "reviewer pool"...

Thank you @unbeatable-101, it looks all good from my side. I'm not sure I'll have the time this or next week to do the screenshots. If you don't get access to the knut account in the meantime (I'm not the one deciding), I'll do them in two weeks. We also need someone else to review it. @n maybe? I don't really know who's in the "reviewer pool"...
ivan-paleo refused to review 1 year ago
ivan-paleo approved these changes 1 year ago
hw commented 1 year ago
Owner

@ivan-paleo : The knut account has been maintained by Lucas, now looking for a new maintainer I guess. @ivan-paleo and @n have access to credentials and should be able to add new members. Please let me know if you need help for this.

@ivan-paleo : The knut account has been maintained by Lucas, now looking for a new maintainer I guess. @ivan-paleo and @n have access to credentials and should be able to add new members. Please let me know if you need help for this.
n changed target branch from master to tags-and-releases 1 year ago
n requested changes 1 year ago
n left a comment

Thank you for the PR. I've changed your PR to merge to a branch so I can add the screenshots under the Knut account before merging into master. I left some comments for review. Additionally, please revert the package-lock.json file.

Once you're done, remove WIP from the title and I can get to merging :)

.gitignore Outdated
# General
n commented 1 year ago
Poster
Collaborator

Let's revert this change to the .gitignore file since these are files not specific to this project. You can add these to your personal .gitignore file instead.

Let's revert this change to the .gitignore file since these are files not specific to this project. You can add these to your personal .gitignore file instead.
unbeatable-101 marked this conversation as resolved
---
# What are tags and releases?
Tags are a git function used to show where a repository was during a certain release (e.g. v1.2.4), sort of like a shortcut to what it looked like at the time. Tags always include a source code download for that time, and are usally paired with a release (e.g. an EXE or DMG file) when applicable.
n commented 1 year ago
Poster
Collaborator

Typo: usally --> usually

Typo: usally --> usually
unbeatable-101 marked this conversation as resolved
Tags are a git function used to show where a repository was during a certain release (e.g. v1.2.4), sort of like a shortcut to what it looked like at the time. Tags always include a source code download for that time, and are usally paired with a release (e.g. an EXE or DMG file) when applicable.
## Wait, what is the difference between tags and releases?
They are very similar, the difference being that tags are just the repository frozen in time and are part of git (You can make one using git), releases are tags acompanied with a binary file and are not part of git (You need to go to your Codeberg repository page to add the binary).
n commented 1 year ago
Poster
Collaborator

Typo: acompanied --> accompanied

Typo: acompanied --> accompanied
unbeatable-101 marked this conversation as resolved
## Making new tags
### Codeberg<br>
n commented 1 year ago
Poster
Collaborator

The br tags are not necessary.

The br tags are not necessary.
unbeatable-101 marked this conversation as resolved
n commented 1 year ago
Collaborator

@ivan-paleo, I can't access https://codeberg-test.org, could you do the screenshots?

@n or @hw: can we give @unbeatable-101 access to it, or allow him to do screenshots?

@ivan-paleo since Knut was intended to be shared with regular, trusted contributors, lets re-evaluate giving access to them later on.

@ivan-paleo and @n have access to credentials and should be able to add new members. Please let me know if you need help for this.

@hw We've only been given rw access to the Knut org. Could you expand our permissions?

> > @ivan-paleo, I can't access https://codeberg-test.org, could you do the screenshots? > > @n or @hw: can we give @unbeatable-101 access to it, or allow him to do screenshots? @ivan-paleo since Knut was intended to be shared with regular, trusted contributors, lets re-evaluate giving access to them later on. > @ivan-paleo and @n have access to credentials and should be able to add new members. Please let me know if you need help for this. @hw We've only been given rw access to the Knut org. Could you expand our permissions?
n added the
Kind: Documentation
Status: Review
labels 1 year ago
unbeatable-101 changed title from WIP: Tags and Releases Documentation to Tags and Releases Documentation 1 year ago
unbeatable-101 requested review from n 1 year ago
hw commented 1 year ago
Owner

@hw We've only been given rw access to the Knut org. Could you expand our permissions?

fixed.

> > @hw We've only been given rw access to the Knut org. Could you expand our permissions? fixed.

Isn't all ready? What is still needed before merging?
(I lost track of it in the last weeks, sorry)

Isn't all ready? What is still needed before merging? (I lost track of it in the last weeks, sorry)
Poster

It is ready, just waiting for @n

It is ready, just waiting for @n
hw commented 1 year ago
Owner

please ping again in a couple if needed, happy to merge if necessary

please ping again in a couple if needed, happy to merge if necessary
Poster

@hw, @n said they would make it a branch so that they could add screen shots using the foo account

@hw, @n said they would make it a branch so that they could add screen shots using the foo account
n commented 1 year ago
Collaborator

It is ready, just waiting for @n

Apologies, I must have missed the notification for review.

> It is ready, just waiting for @n Apologies, I must have missed the notification for review.
n merged commit 9d575e5d1b into tags-and-releases 1 year ago
n approved these changes 1 year ago
hw referenced this issue from a commit 9 months ago

Reviewers

ivan-paleo approved these changes 1 year ago
n approved these changes 1 year ago
The pull request has been merged as 9d575e5d1b.
Sign in to join this conversation.
No reviewers
No Milestone
No Assignees
4 Participants
Notifications
Total Time Spent: 19h 46min 7s
William Davis
19h 46min 7s
Due Date

No due date set.

Dependencies

This pull request currently doesn't have any dependencies.

Loading…
There is no content yet.