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

Status: 2023q3: portmgr: fixes, other changes #280

Closed

Conversation

grahamperrin
Copy link
Contributor

@grahamperrin grahamperrin commented Oct 12, 2023

Correctly spell Joel's surname.

Remove FreeBSD Ports Monitoring.

Alter the URL for the tarball, based on the redirect.

About FreeBSD Ports no longer exists. Seek portmgr@ advice, then alter the URL.

The collated report will be for Q3 as if it was written during (not after) the events of Q3, so 'this quarter' is Q3.

Consistent use of 'this' for Q3 allows the comparison with 'last quarter' to make sense. (Logically: you can not compare last quarter with last quarter.)

Fix, or add, markup for list items (bullet points).

Consider use of subheadings.

Other suggested changes.

Correctly spell Joel's surname.

The collated report will be for Q3 as if it was written during (not
after) the events of Q3, so 'this quarter' is Q3.

Consistent use of 'this' for Q3 allows the comparison with 'last
quarter' to make sense.  (Logically: you can not compare last quarter
with last quarter.)
Fix markup for list items (bullet points).  Whilst there: tentatively create two subheadings.

I suspect that one large point in isolation was originally intended to be a simple paragraph.

Tentatively format phrases such as 'USES'.
Conciseness.

Consistency: as pgkmgr@ was used to describe a group's work at the end
of the report, so portmgr@ (with the trailing @) might be used near
the beginning of the report.

Tentatively use indented list items in the portmgr@ work and discussion
paragraph.
@grahamperrin grahamperrin marked this pull request as ready for review October 13, 2023 18:11
@grahamperrin
Copy link
Contributor Author

grahamperrin commented Oct 13, 2023

Current edition:

@rene0 hello, whilst correcting the surname for @Tectu, and whilst fixing markup for bullet points, I made other suggested changes:

How do they look?

@grahamperrin grahamperrin marked this pull request as draft October 14, 2023 01:46
@grahamperrin

This comment was marked as outdated.

@grahamperrin

This comment was marked as resolved.

@@ -3,40 +3,47 @@
Links: +
link:https://www.FreeBSD.org/ports/[About FreeBSD Ports] URL:link:https://www.FreeBSD.org/ports/[] +
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bapt @mat813 @pizzamig @rene0 @tcberner (Moinur Rahman not in GitHub, I guess)

About FreeBSD Ports no longer exists.

For status report purposes, please:

  • which alternative page will portmgr prefer?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://ports.freebsd.org/cgi/ports.cgi?stype=faq includes a link out to https://docs.freebsd.org/en/books/handbook/ports/#ports-using, so maybe Using the Ports Collection should supersede About FreeBSD Ports.

Thoughts?

TIA

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless someone from portmgr replies, please leave the link as it is. It might also be that the page is planned to be changed in some near future.

'took in … for safe-keeping' (not 'took … in for safe-keeping').

Subtly better, I think.
@lsalvadore
Copy link
Member

@grahamperrin : Please try to finish your draft soon enough: we are already in the second half of the month and I would like to publish the status report within the month.

Please try to be quick with the other coming reports. It is not needed that they are 100% perfect. As long as they are clear and grammatically correct it is fine. Writing style is an author's choice and it does not need to be improved more than what is required in https://docs.freebsd.org/en/books/fdp-primer/writing-style/ .

As usual, thanks for your reviews.

@grahamperrin
Copy link
Contributor Author

@lsalvadore thanks, understood.

If you like, I can replace the primary link About FreeBSD Ports (removed) with FreeBSD Ports Search (targeted by the redirect), however this is so significant a change – the two pages serve quite different purposes – that IMHO a member of portmgr@ should advise. I don't want to overstep the mark.

The primary link as it was before the page was removed: https://web.archive.org/web/20230915210803/https://www.freebsd.org/ports/

@grahamperrin grahamperrin marked this pull request as ready for review October 18, 2023 07:47
@grahamperrin
Copy link
Contributor Author

grahamperrin commented Oct 18, 2023

For clarity: this was a draft only because I thought it inappropriate to treat it as truly ready with the primary link no longer valid.

Postscript, to ease comparison, PDFs of rendered pages:

  1. bf179c6002ea, currently on the main branch
  2. 90077e8af5d0, currently on the grahamperrin-status-portmgr branch

Copy link
Member

@lsalvadore lsalvadore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please leave the original structure (bullet points, headers etc.) of the report as it was originally (unless portmgr approves your changes). I approve the rewording.

Thanks.

@@ -3,40 +3,47 @@
Links: +
link:https://www.FreeBSD.org/ports/[About FreeBSD Ports] URL:link:https://www.FreeBSD.org/ports/[] +
link:https://docs.freebsd.org/en/articles/contributing/#ports-contributing[Contributing to Ports] URL: link:https://docs.freebsd.org/en/articles/contributing/#ports-contributing[] +
link:http://portsmon.freebsd.org/[FreeBSD Ports Monitoring] URL: link:http://portsmon.freebsd.org/[] +
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree on removing this. Portsmon does not exist anymore and the link redirects on an already listed link.

@lsalvadore
Copy link
Member

@grahamperrin : Please try to revert the structural changes soon: I plan to publish the report within a few days.

Thanks.

@Tectu
Copy link
Contributor

Tectu commented Oct 28, 2023

If my name could get fixed that would certainly be much appreciated :D

@rene0
Copy link
Member

rene0 commented Oct 28, 2023

@lsalvadore can I just do a regular doc commit to fix Joel's surname?

@grahamperrin

This comment was marked as outdated.

Aim to resolve freebsd#280 (review)

Original structure (bullet points, headers etc.).
@grahamperrin

This comment was marked as outdated.

A second attempt to revert to original structure (bullet points, headers etc.).
@lsalvadore
Copy link
Member

@lsalvadore can I just do a regular doc commit to fix Joel's surname?

Sure, if this is the only fix you would like to accept feel free to do such commit and then we will close this pull request.

@rene0
Copy link
Member

rene0 commented Oct 29, 2023

@lsalvadore I fixed @Tectu 's name in commit https://cgit.freebsd.org/doc/commit/?id=4c632833681eac361789687e1c030c4930879794

@lsalvadore
Copy link
Member

Ok, I guess we can close this PR now then.

Thanks everyone.

@lsalvadore lsalvadore closed this Oct 29, 2023
@grahamperrin grahamperrin deleted the grahamperrin-status-portmgr branch October 29, 2023 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants