Changeset View
Changeset View
Standalone View
Standalone View
documentation/content/en/books/fdp-primer/translations/_index.adoc
Show First 20 Lines • Show All 154 Lines • ▼ Show 20 Lines | |||||
Use git diff command to generate a diff and send it to the link:reviews.freebsd.org/[reviews system]. | Use git diff command to generate a diff and send it to the link:reviews.freebsd.org/[reviews system]. | ||||
[source,shell] | [source,shell] | ||||
.... | .... | ||||
% git diff > sv-faq.diff | % git diff > sv-faq.diff | ||||
.... | .... | ||||
Either way, you should use Bugzilla to link:https://bugs.freebsd.org/bugzilla/enter_bug.cgi[submit a report] indicating that you have submitted the documentation. | You should use Bugzilla to link:https://bugs.freebsd.org/bugzilla/enter_bug.cgi[submit a report] indicating that you have submitted the documentation. | ||||
It would be very helpful if you could get other people to look over your translation and double check it first, since it is unlikely that the person committing it will be fluent in the language. | It would be very helpful if you could get other people to look over your translation and double check it first, since it is unlikely that the person committing it will be fluent in the language. | ||||
Someone (probably the Documentation Project Manager, currently {doceng}) will then take your translation and confirm that it builds. | Someone (probably the Documentation Project Manager, currently {doceng}) will then take your translation and confirm that it builds. | ||||
In particular, the following things will be looked at: | In particular, the following things will be looked at: | ||||
. Does `make` in the [.filename]#root# directory work correctly? | . Does `make` in the [.filename]#root# directory work correctly? | ||||
If there are any problems then whoever is looking at the submission will get back to you to work them out. | If there are any problems then whoever is looking at the submission will get back to you to work them out. | ||||
Show All 24 Lines | |||||
=== Do I need to include any additional information in my translations? | === Do I need to include any additional information in my translations? | ||||
Yes. | Yes. | ||||
The header of the English version of each document will look something like this: | The header of the English version of each document will look something like this: | ||||
[.programlisting] | [.programlisting] | ||||
.... | .... | ||||
--- | --- | ||||
title: Why you should use a BSD style license for your Open Source Project | title: Why you should use a BSD style license for your Open Source Project | ||||
releaseinfo: "$FreeBSD: head/en_US.ISO8859-1/articles/bsdl-gpl/article.xml 53942 2020-03-01 12:23:40Z carlavilla $" | releaseinfo: "$FreeBSD: head/en_US.ISO8859-1/articles/bsdl-gpl/article.xml 53942 2020-03-01 12:23:40Z carlavilla $" | ||||
trademarks: ["freebsd", "intel", "general"] | trademarks: ["freebsd", "intel", "general"] | ||||
--- | --- | ||||
\= Why you should use a BSD style license for your Open Source Project | = Why you should use a BSD style license for your Open Source Project | ||||
.... | .... | ||||
The exact boilerplate may change, but it will always include a $FreeBSD$ line and the phrase `The FreeBSD Documentation Project`. | The exact boilerplate may change, but it will always include a $FreeBSD$ line and the phrase `The FreeBSD Documentation Project`. | ||||
Note that the $FreeBSD$ part is expanded automatically by Git, so it should be empty (just `$FreeBSD$`) for new files. | Note that the $FreeBSD$ part is expanded automatically by Git, so it should be empty (just `$FreeBSD$`) for new files. | ||||
Your translated documents should include their own FreeBSD line, and change the `FreeBSD Documentation Project` line to `The FreeBSD _language_ Documentation Project`. | Your translated documents should include their own FreeBSD line, and change the `FreeBSD Documentation Project` line to `The FreeBSD _language_ Documentation Project`. | ||||
In addition, you should add a third line which indicates which revision of the English text this is based on. | In addition, you should add a third line which indicates which revision of the English text this is based on. | ||||
So, the Spanish version of this file might start: | So, the Spanish version of this file might start: | ||||
[.programlisting] | [.programlisting] | ||||
.... | .... | ||||
--- | --- | ||||
title: Soporte para segundos intercalares en FreeBSD | title: Soporte para segundos intercalares en FreeBSD | ||||
releaseinfo: "$FreeBSD: head/es_ES.ISO8859-1/articles/leap-seconds/article.xml 53090 2019-06-01 17:52:59Z carlavilla $" | releaseinfo: "$FreeBSD: head/es_ES.ISO8859-1/articles/leap-seconds/article.xml 53090 2019-06-01 17:52:59Z carlavilla $" | ||||
--- | --- | ||||
\= Soporte para segundos intercalares en FreeBSD | = Soporte para segundos intercalares en FreeBSD | ||||
.... | .... |