diff --git a/website/content/en/internal/about.adoc b/website/content/en/internal/about.adoc index 79b96eac19..3bab403728 100644 --- a/website/content/en/internal/about.adoc +++ b/website/content/en/internal/about.adoc @@ -1,60 +1,60 @@ --- title: "About the FreeBSD WWW Server" sidenav: docs --- include::shared/en/urls.adoc[] = About the FreeBSD WWW Server == The Machine [.right] image:../../gifs/powerlogo.gif[Powered by FreeBSD] Naturally, all systems in the FreeBSD.org cluster run FreeBSD. The hardware and network connection have been generously provided by https://www.bytemark.co.uk/[Bytemark Hosting], https://www.isc.org/[Internet Systems Consortium], https://www.cs.nctu.edu.tw/cswebsite/[National Chiao Tung University], https://www.nyi.net/[New York Internet], https://www.rootbsd.net//[RootBSD], https://www.yandex.com/[Yandex], https://www.yahoo.com/[Yahoo!], and other link:../../donations/donors[contributors] to the FreeBSD project. A list of general-access machines in the FreeBSD.org domain is available at the link:../machines[The FreeBSD.org Network] page. == The Software These pages are served up by the fast and flexible http://www.nginx.org/[nginx webserver]. In addition, there are a few locally crafted CGI scripts. Indexing of the mailing list archive are provided by freewais-sf, a derivative of the CNIDR freewais. == The Pages [.right] image:../../gifs/lynx.gif[Lynx Friendly logo] The original web pages were put together by John Fieber https://people.FreeBSD.org/~jfieber/[] with input from the FreeBSD community and *you*. http://wolfram.schneider.org[] was our first webmaster but this responsibility is now shared by a larger team of web and documentation contributors. The FreeBSD pages are valid XHTML 1.0 Transitional and should degrade gracefully on any browser. See also the link:../../docproj/[FreeBSD Documentation Project] == Page Design The current website design was done by Emily Boyd as part of the https://summerofcode.withgoogle.com[Google Summer of Code] program in 2005. The original page design was done by Megan McCormack. == link:{fdp-primer}#the-website-build[Building and updating the FreeBSD Web Pages] -This document describes how to build and update the FreeBSD Web pages from the Subversion repository by hand. +This document describes how to build and update the FreeBSD Web pages from the Git repository by hand. == Update of the FreeBSD Web Pages The FreeBSD Web Pages on `www.FreeBSD.org` are currently rebuilt according to the following schedule: [.tblbasic] [cols=",",options="header",] |=== |Build Time (UTC) |Build type |Every 10 minutes |English www only, if no other build is running |Every Sunday at 00:00 |Full build with a new tree checkout |Every 1 hour |English only |Every 3 hours |Full build |=== == Mirroring the FreeBSD Web Pages It is possible to link:../mirror[mirror] the FreeBSD web pages on www.FreeBSD.org. link:..[FreeBSD Internal Home] diff --git a/website/content/en/internal/developer.adoc b/website/content/en/internal/developer.adoc index 421d73c7b2..43cc11fe27 100644 --- a/website/content/en/internal/developer.adoc +++ b/website/content/en/internal/developer.adoc @@ -1,43 +1,43 @@ --- title: "Resources for FreeBSD Committers" sidenav: docs --- include::shared/en/urls.adoc[] = Resources for FreeBSD Committers == link:{committers-guide}[Committers Guide] -This document is an overall guide for all new committers, including both technical details and policy details. For the former, see the chapters on link:{committers-guide}#subversion-primer[the Subversion VCS], the link:{committers-guide}#bugzilla[Bugzilla] bug tracking system, and the link:{committers-guide}#ssh.guide[SSH Quick-Start Guide]. +This document is an overall guide for all new committers, including both technical details and policy details. For the former, see the chapters on link:{committers-guide}#git-primer[the Git VCS], the link:{committers-guide}#bugzilla[Bugzilla] bug tracking system, and the link:{committers-guide}#ssh.guide[SSH Quick-Start Guide]. It contains almost everything a new committer to the FreeBSD Project needs to know. See the Documentation Project Primer and the Ports Guide, below, for more info. == link:{fdp-primer}[FreeBSD Documentation Project Primer for New Contributors] This primer covers everything you will need to know in order to start contributing to the FreeBSD Documentation Project, from the tools and software you will be using (both mandatory and recommended) to the philosophy behind the Documentation Project. == link:{porters-handbook}[FreeBSD Porter's Handbook] A guide for FreeBSD ports committers. This includes the canonical link:{porters-handbook}#versions[Table of __FreeBSD_version Values]. == link:{fdp-primer}#the-website-build[How to build the FreeBSD Web Pages]. -This document describes how to build and update the FreeBSD Web pages from the SVN repository by hand. +This document describes how to build and update the FreeBSD Web pages from the Git repository by hand. == FreeBSD Projects * link:../../docproj/[FreeBSD Documentation Project] * link:../../releng/[FreeBSD Release Engineering] * link:../../platforms/[FreeBSD Hardware Platforms Projects] * link:../../projects/[FreeBSD Development Projects] == Other Resources * link:../../developers/cvs/[Source Code Repositories] * link:../../support/[Bug Reports] * link:../../security/[FreeBSD Security Information] * link:../../copyright/[Copyright] * https://wiki.FreeBSD.org[FreeBSD Wiki] link:..[FreeBSD Internal Home] diff --git a/website/content/en/internal/doceng.adoc b/website/content/en/internal/doceng.adoc index 1c393df1aa..d5ab9a97aa 100644 --- a/website/content/en/internal/doceng.adoc +++ b/website/content/en/internal/doceng.adoc @@ -1,32 +1,32 @@ --- title: "FreeBSD Doceng Team Charter" sidenav: docs --- include::shared/authors.adoc[] = FreeBSD Doceng Team Charter The doceng@ team is a body to handle some of the meta-project issues associated with the FreeBSD Documentation Project. The main responsibilities of this team are: * To grant approval for new documentation committers. Documentation includes articles and books, website pages, manual pages, release notes and translations of the above. There are two kinds of doc commit bits: translator commit bit, which is limited to translations in a particular language and full commit bit, which is only granted to aspirants, who have shown enough English writing skills. * To maintain the doc project primer, which documents best practices for the FreeBSD Documentation Project. * To manage the doc/ release process. This includes coordinating the release documentation updates with the various translation teams, coordinating with the release engineering team to tag the doc/ tree during the release cycle, and documenting these procedures. -* To ensure that the generated documentation (PDF, HTML, etc.) on the Web site and FTP site are up to date with respect to the versions of the documents in the SVN tree. This includes making sure the Web site build is functioning correctly, and also involves working with the admin team to ensure that the primary Web server has all of the requisite software installed (including build scripts). +* To ensure that the generated documentation (PDF, HTML, etc.) on the Web site and FTP site are up to date with respect to the versions of the documents in the Git tree. This includes making sure the Web site build is functioning correctly, and also involves working with the admin team to ensure that the primary Web server has all of the requisite software installed (including build scripts). * To act as MAINTAINER (when necessary) or to work in coordination with existing MAINTAINERs, to ensure that the documentation toolchains (DocBook, groff, etc.) are in good working order. * To maintain the sanctity of the FreeBSD doc/ tree. Due to the visibility of these files and documents to the outside world, doceng@ reserves the right to immediately backout (or fix without waiting for response from the original committer) changes that introduce broken links, cause the Web site build to break, or otherwise degrade the accessibility of the FreeBSD Web site and documentation. * To appoint and oversee a FreeBSD Webmaster Team that carries out daily maintenance of the Project web servers in collaboration with other teams. It is specifically noted here that doceng@ is *not* a conflict resolution body for the FreeBSD Documentation Project. Discussion and consensus on the freebsd-doc mailing list is how the project has conducted itself, and how it is expected to conduct itself in the future. == Current Membership The current members of this team are {doceng-members}. == New Doc Committers New doc committers are approved by doceng@ with a vote through email and a two week timeout. A committer is approved if at least one doceng@ member votes yes, and no doceng@ members vote no. When a commit bit proposal is accepted, doceng@ sends out an acceptance email to the mentor and the new committer with core@ and accounts@ CC'ed. == Idle Doc Committers Doc Committers that have not made a commit in 18 months will be contacted by a doceng@ member and without a response after a delay of 2 weeks, these committers will be automatically removed from the access file. In case of no response, doceng@ will also contact core@ about the idle committers. Committers that wish to get back their commit bits will have to reapply with the appropriate authority. diff --git a/website/content/en/internal/new-account.adoc b/website/content/en/internal/new-account.adoc index 76d1f06ae5..530db544c1 100644 --- a/website/content/en/internal/new-account.adoc +++ b/website/content/en/internal/new-account.adoc @@ -1,72 +1,72 @@ --- title: "New Account Creation Procedure" sidenav: docs --- include::shared/en/urls.adoc[] = New Account Creation Procedure == Proposing a new committer If you want to propose a new committer, you should send the following information to the appropriate entity: * Information on what established (FreeBSD) track record the nominee has. This is _not_ optional. * Who has volunteered to become the mentor for the new committer. * The email address of the nominee (remarkably often this is omitted). Any commit bit requests that do not follow the guidelines outlined above will be delayed (at best) or earn you negative vibrations from the respective team/team secretary. For some guidelines on how the proposal itself should be written, please see link:../proposing-committers[a brief summary]. Responsible party for this procedure is: * src -> core@ * doc -> doceng@ * ports -> portmgr@ You will get ACK after the message is seen, and core@, doceng@ and portmgr@ will give you a response after voting is finished or when the timeout is hit. The timeout for core@ and portmgr@ is set to 7 days while for doceng@ it is 14 days, however, as indicated, this is just a worst case and team members may finish voting earlier. == Authorizing A New Account Someone from the list below sends a PGP-signed email to accounts@, the person assigned as the mentor to the new committer, and copied to core@FreeBSD.org confirming the approval of the new account. This email should include a link to this document so the mentor/mentee know what is expected of them. New account approvals are only valid from these PGP entities: * core-secretary (for src commit bits) * portmgr-secretary (for ports commit bits) * doceng-secretary (for doc commit bits) _NOTE: New account requests from anyone other than these entities or requests signed with PGP keys other than from these entities will not be acted upon. No exceptions. In case of a new ports or doc committer the account request email should be CC:-ed to core._ == Information Needed From The Mentor The person assigned as the new committers' mentor needs to collect and send the following information to accounts@: * username (lowercase a-z and 0-9) * Full Name (as would go in a GECOS field; UTF-8 encoded) * optional additional GECOS information (phone, location etc) * shell (sh, csh/tcsh, bash, zsh are available) * ssh V2 public key The mentor is responsible for obtaining this information from the new committer in a secure fashion, and providing it to accounts@ in a secure fashion. PGP-signed email, with the mentor's public key already committed to the Handbook, is the preferred method for the mentor to send the information to accounts@. If this is impossible for some reason an acceptable substitute is for the mentor to place the account information in their home directory on freefall and then tell accounts@ where to find it. We need to be sure the account information really is coming from the Mentor and unsigned email is not sufficient for this these days. Since accounts@ has no way to verify anything from the new Committer this information needs to be sent to accounts@ by the Mentor, not the new Committer. == accounts@ Creates New Account accounts@ creates the new account with the above information on the FreeBSD.org cluster and notifies the mentor and the new committer. == Mentor Activates New Committer's Commit Bit -After the new committer confirms that the account works, the mentor adds the new committer to the correct `access` file, using an appropriate commit message. The commit message should at least contain the committer's full name and username, the mentor's name and what area the new committer will start to work in. An entry should also be added to the `mentors` file in the respective Subversion repository to indicate the mentor relationship. Having done all that, the new committer and mentor jointly go through the first commit operations. +After the new committer confirms that the account works, the mentor adds the new committer to the correct `access` file, using an appropriate commit message. The commit message should at least contain the committer's full name and username, the mentor's name and what area the new committer will start to work in. An entry should also be added to the `mentors` file in the respective Git repository to indicate the mentor relationship. Having done all that, the new committer and mentor jointly go through the first commit operations. == Additional Services The mentor should add the new committer to the https://wiki.freebsd.org/DevelopersGroup[Developers group] on the wiki and to the https://reviews.freebsd.org/project/view/3/[committer] project on Phabricator. Reading the link:{committers-guide}[Committer's Guide] is considered a good first step for new committers, especially the link:{committers-guide}#"conventions.html[Conventions and Traditions] section. == End Of Mentorship -There is no pre-set duration for a mentorship. Once the mentor feels the mentee is ready to 'fly solo' the mentor notifies the developer community by removing the entry from the `mentors` file in SVN. +There is no pre-set duration for a mentorship. Once the mentor feels the mentee is ready to 'fly solo' the mentor notifies the developer community by removing the entry from the `mentors` file in Git. == Transfer Of Mentorship -Should a need arise to transfer mentorship for a committer please email the responsible party, as described for a new account proposal. Typically this request is rubberstamped as-is. In Subversion, the `mentors` file should be updated. +Should a need arise to transfer mentorship for a committer please email the responsible party, as described for a new account proposal. Typically this request is rubberstamped as-is. In Git, the `mentors` file should be updated.