Page MenuHomeFreeBSD

Add USE_GITLAB documentation
ClosedPublic

Authored by ultima on Sep 6 2017, 9:02 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Mar 2, 8:08 PM
Unknown Object (File)
Dec 22 2023, 11:12 PM
Unknown Object (File)
Nov 19 2023, 8:01 AM
Unknown Object (File)
Nov 17 2023, 8:01 AM
Unknown Object (File)
Nov 15 2023, 12:13 PM
Unknown Object (File)
Nov 15 2023, 11:14 AM
Unknown Object (File)
Nov 12 2023, 7:35 AM
Unknown Object (File)
Nov 9 2023, 2:27 AM
Subscribers

Details

Reviewers
mat
Group Reviewers
Doc Committers
Commits
rD51456: * Add USE_GITLAB
Summary

Add USE_GITLAB documentation with examples

Reviewed by\: lifanov (mentor), matthew (mentor), docscommitter
Approved by\: lifanov (mentor), matthew (mentor), docscommitter
Differential Revision\: https://reviews.freebsd.org/DXXXXX

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 11772
Build 12116: arc lint + arc unit

Event Timeline

Balance </sect 2> is buildable

As this is a commit against the docs repo, you don't need approval from Nikolai or me, but you will need approval from someone with a docs commit bit.

As this is a commit against the docs repo, you don't need approval from Nikolai or me, but you will need approval from someone with a docs commit bit.

Ah, okay. I thought all commits required mentor approval, so this means only the case under the commit bit type.

As this is a commit against the docs repo, you don't need approval from Nikolai or me, but you will need approval from someone with a docs commit bit.

Ah, okay. I thought all commits required mentor approval, so this means only the case under the commit bit type.

If you are being mentored, all commits require your mentors approval, wherever the commit goes.
This also requires some doc committer approval. I'll have a look at it next week. (As I will have a look at the USE_GITLAB changes you made, have not had time this week.)

In D12261#254651, @mat wrote:

As this is a commit against the docs repo, you don't need approval from Nikolai or me, but you will need approval from someone with a docs commit bit.

Ah, okay. I thought all commits required mentor approval, so this means only the case under the commit bit type.

If you are being mentored, all commits require your mentors approval, wherever the commit goes.
This also requires some doc committer approval. I'll have a look at it next week. (As I will have a look at the USE_GITLAB changes you made, have not had time this week.)

Its no problem, take your time. This isn't a small change that is easily glanced at afterall.

en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
2884
​ <application>GitLab</application>, these variables are available for uses and

(and all other occurrences of Gitlab)

2886

empty line between para and table.

2946–2948

I wonder if there is a way to express the optionalliness (yes, I wrote it, so it exists) of those two directly in docbook. (but it is not important)

2954–2956

the </table> and <example> should have the same indentation, but there is a good chance that it is phabricator being stupid.

2961

maybe on gitlab.com it is kind of vague otherwise, the whole chapter is about Gitlab, one can assume you're going to talk about it.

2975
xlink:href="https://gitlab.com">gitlab.com</link> and

(because it would probably be better to have a different way of saying Gitlab as an application, and gitlab.com, the web site.)

2987

RFC 6761 describe domains names to be used in documentation, domains that are expected to not exist and the users know are for documentation purposes only.
You should probably use, something like <literal>http://git.example.com</literal> to make sure of that. (I added the literal for free 😉)

3007
the date the commit to the &os; ports tree is made.</para>
3008–3009

empty line between tip and note.

3026
default distribution file is not fetched from a GitLab site.

(Because a default distribution is somewhat required, I know, you copied it from something I wrote, would be nice to fix it too 😇.)

Thanks for taking a look mat, trust me I'm not trying to mask the fact that some/part/most of the docs were copied then modified instead of created from scratch. These areas are still a bit above my skill level and it will definitely take some time before I get to the point of writing from zero.

I'v been a bit busy lately with interviewing / studying and such, will try and get to the corrections on the weekend, and also submit the correct for GitHub if I have the time.

Thanks for taking a look mat, trust me I'm not trying to mask the fact that some/part/most of the docs were copied then modified instead of created from scratch. These areas are still a bit above my skill level and it will definitely take some time before I get to the point of writing from zero.

Well, I would not have noticed you copied stuff if not for phabricator's little orange tab at the start of the line saying "copied from line xxx" :-)

I'v been a bit busy lately with interviewing / studying and such, will try and get to the corrections on the weekend, and also submit the correct for GitHub if I have the time.

Sure, no rush.

ultima marked 9 inline comments as done.
  • Fixed various items
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
2954–2956

Looks like it was actually my mistake, fixed!

2987

Good to know, example.com has been dubbed the example domain. RFC 6761 Bookmarked!

I'm pretty sure if you did charge I would be in debt for years. >.<

en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
3026

The fix for GitHub is at D12512

I completely forgot about this.

This revision is now accepted and ready to land.Feb 19 2018, 1:23 PM
wblock added inline comments.
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
2885

Should that be "available for use" or does it really mean USES?

Also, s/may/might/ (because "may" usually means permission, and "might" is when something has a probability).

  • s/uses/use ; s/may/might/
This revision now requires review to proceed.Mar 3 2018, 6:58 AM
ultima added inline comments.
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
2885

Nice catch, I should have probably realized the uses sounded a bit off when I fixed it! >.<

This revision was not accepted when it landed; it landed in state Needs Review.Mar 3 2018, 7:03 AM
Closed by commit rD51456: * Add USE_GITLAB (authored by ultima). · Explain Why
This revision was automatically updated to reflect the committed changes.
ultima marked an inline comment as done.