FAQ renew - Working Group

[carlavilla]

Summary

The idea of the FAQ Working group was to simplify the FreeBSD FAQ, reorder some sections and eliminate others.

Here I have added the list of headings, if no one is against or thinks that something is missing to be added, in 2 weeks we will begin to fill in the different sections.

The idea is to try not to reference any version of FreeBSD and try to make the questions and answers global.

The idea is also to keep the FAQ as clean and clear as possible.
For specific things or how to perform a certain task we already have the Handbook and the different articles.

To read more easily: https://people.freebsd.org/~carlavilla/handbook-wg/faq.html

[carlavilla]

Add some entries proposed by fernape@

[fernape]

LGTM.

I added one more item. If it overlaps with the answer to another FAQ, we can remove it.

[carlavilla]

Add introduction section

[emaste]

documentation/content/en/books/faq/_index.adoc

36

are these really supposed to be unicode ellipses? …

561–562

add "elected" to Core Team

561–562

I'd say "many" instead of "most."

562–564

I would just drop these explicit references, just mention what FreeBSD's goals are.

[carlavilla]

Fix comments from @emaste

[fernape]

documentation/content/en/books/faq/_index.adoc

561–562

Since this does not pretend to be an exhaustive list, I would use a disjunctive:

...such as the overall direction of the project and who is allowed... --> ...such as the overall direction of the project or who is allowed...

561–562

I'm not sure if this should be Feel free to modify, distribute...

561–562

Although it was in the original too, shouldn't the comma be *after* though?

...comes with slightly more strings attached, though at least on the side of enforced access rather than the usual opposite. --> ...comes with slightly more strings attached though, at least on the side of enforced access rather than the usual opposite.

562

...between FreeBSD and NetBSD, OpenBSD, and other... --> ...between FreeBSD, NetBSD, OpenBSD, and other...

562

To avoid repeating snapshot how about?

These snapshots represent a snapshot in time... --> These snapshots capture a moment in time...

562

I had the idea that there is a hard coded limit in the code... FreeBSD can support more, but then the limit needs to be changed and the kernel recompiled.

562

This paragraph title does not render properly, but that is most likely due to the empty body in the previous one.

563

I would remove this sentence.
It does not belong to this section, but to the next one where there is already a very similar sentence.

563

Link to books/handbook/ports?

[fernape]

Trying to fix the offset of the comments after the update in the review.

documentation/content/en/books/faq/_index.adoc

561–562

Since this does not pretend to be an exhaustive list, I would use a disjunctive:

...such as the overall direction of the project and who is allowed... --> ...such as the overall direction of the project or who is allowed...

561–562

I'm not sure if this should be Feel free to modify, distribute... or The license means you are free to modify...

561–562

Although it was in the original too, shouldn't the comma be after though?

...comes with slightly more strings attached, though at least on the side of enforced access rather than the usual opposite. --> ...comes with slightly more strings attached though, at least on the side of enforced access rather than the usual opposite.

562

...between FreeBSD and NetBSD, OpenBSD, and other... --> ...between FreeBSD, NetBSD, OpenBSD, and other...

563

I would remove this sentence.
It does not belong to this section, but to the next one where there is already a very similar sentence.

563

Link to books/handbook/ports?

[carlavilla]

documentation/content/en/books/faq/_index.adoc

562

Yes, that is why, in the final version we will not have that problem :)

562

I will ask @emaste or @jhb to see if they can help us with this question, I leave the comment unmarked.

563

Personally I prefer to keep the links between documents to a minimum, but if you think it is essential to add links here, I can add the links without problems

[carlavilla]

Fix Fernando's comments

[carlavilla]

Add more sections

[fernape]

documentation/content/en/books/faq/_index.adoc

561–562

Since we link to the Architecture Handbook, I would link to the Handbook too.

562

Ummm. It doesn't render properly in the preview.

[fernape]

documentation/content/en/books/faq/_index.adoc

561–562

Found it:

$ find . -name param.h -exec egrep -H '.*define.*MAXCPU.*' {} \;
./sys/amd64/include/param.h:#define MAXCPU              1024
./sys/amd64/include/param.h:#define MAXCPU              1
./sys/arm/include/param.h:#define       MAXCPU          4
./sys/arm/include/param.h:#define       MAXCPU          1
./sys/arm64/include/param.h:#define     MAXCPU          1024
./sys/arm64/include/param.h:#define     MAXCPU          1
./sys/i386/include/param.h:#define MAXCPU               32
./sys/i386/include/param.h:#define MAXCPU               1
./sys/powerpc/include/param.h:#define   MAXCPU          256
./sys/powerpc/include/param.h:#define   MAXCPU          1
./sys/riscv/include/param.h:#define     MAXCPU          16
./sys/riscv/include/param.h:#define     MAXCPU          1

Those are the maximum number of CPUs per architecture.

[carlavilla]

Finish the FAQ and fix some comments :)

[carlavilla]

documentation/content/en/books/faq/_index.adoc

561–562

Niceeeeeeeeeeeeeeeeeeeeeeee, thank you for that!!!

[carlavilla]

Still need to check the render issue, working on that

[carlavilla]

Fix render issue

[fernape]

documentation/content/en/books/faq/_index.adoc

415

While this was in the original document, I think the memory consumption of shells is of no relevance these days.

[carlavilla]

documentation/content/en/books/faq/_index.adoc

415

Done :)

[carlavilla]

Fix Fernando's comment

[fernape]

[cc]

Click the the section of "5. Community Questions" from the "Table of Contents" (in your web page link below) does not jump to that section. Other links from the "Table of Contents" work. Please consider if this requires update.

https://people.freebsd.org/~carlavilla/handbook-wg/faq.html

[ashish]

documentation/content/en/books/faq/_index.adoc

222

Is it really recommended for production systems ? This[0] offers opposite advice.

References:
[0] https://docs.freebsd.org/en/books/handbook/cutting-edge/#stable

[carlavilla]

documentation/content/en/books/faq/_index.adoc

222

Good catch :)

[carlavilla]

Fix comments.

[grahamperrin]

I recall accepting the invitation to participate in this working group.