aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/articles/contributing
Commit message (Collapse)AuthorAgeFilesLines
* Regenerate translation filesEd Maste2024-12-291-153/+156
| | | | | | | | Via `sh tools/update_translate_template.sh documentation` Reviewed by: dbaio Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D48234
* contributing: Remove shar referenceEd Maste2024-12-201-1/+0
| | | | | | | | Use of shar for submissions has been deprecated for some time. Reviewed by: kevans, fuz Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D48162
* Fix links that use crossref without descriptionFernando Apesteguía2024-09-221-7/+7
| | | | | | | | | | | | | Summary: Add the anchor text to the crossref macro Test Plan: Apply patch and build the documentation A follow-up change will make the crossref macro fail if no description is used. Subscribers: delphij Differential Revision: https://reviews.freebsd.org/D46721
* doc: Update source files (en .po), for translationsDanilo G. Baio2024-09-141-177/+180
|
* [documentation]: Fix links in all output formatsFernando Apesteguía2024-09-071-7/+8
| | | | | | | | | | | | | Use the crossref: macro for intra-file and intra-book links. This will produce the correct link in Single HTML, Splitted HTML and PDF. Rework the macro to include the PDF special render. While here, briefly document macros. PR: 266107 Reviewed by: bcr@, dbaio@, concussious.bugzilla_runbox.com Differential Revision: https://reviews.freebsd.org/D46480
* documentation/content: Remove references to classMuhammad Moinur Rahman2024-02-271-2/+2
| | | | | | | During the time of gnats we had classes for various problem types which is no longer the case for bugzilla. So remove references to class. Reported by: me@pacopascal.com
* doc: Update source files (en .po), for translationsDanilo G. Baio2024-01-171-269/+284
|
* articles/contributing Pet valeMuhammad Moinur Rahman2023-12-231-40/+90
| | | | | | | - Change INDEX-8 to INDEX-13 - Remove references to portmaster/portupgrade [1] Approved by: portmgr [1]
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-05-211-2/+2
|
* Remove instances of "in order to" to ease readabilityBenedict Reuschling2023-05-181-1/+1
| | | | | | Chapter 11 of the FreeBSD Documentation Project Primer states that language should be clear, short, and simple. This phrasing rarely helps with that and can be cut to a single "to" in pretty much all instances.
* doc: Update source files (en .po), for translationsDanilo G. Baio2023-04-201-157/+256
|
* contributing: Start pointing people at githubWarner Losh2023-02-111-0/+23
| | | | | | | | | | | Start pointing people to submitting github pull requests for simple changes. Provide some guidance on what is a simple change. This is a continuation of earlier experiments with the best way to process patches. Sponsored by: Netflix Reviewed by: debdrup, brooks, allanjude Differential Revision: https://reviews.freebsd.org/D38382
* doc: Add source .po files for translationsDanilo G. Baio2022-08-071-0/+1524
| | | | | | | | | | | | | | | | | | This helps the Weblate translation workflow and offline translations through .po files, it's important to update these files constantly. The goal here is to have a semi-automated translation workflow; Weblate will pull updates automatically from the main repository and commit translations to another repository. Doc committers are encouraged to update the source .po files whenever there are updates in the English documentation part. $ ./tools/update_translate_template.sh documentation Anyway, I'll keep doing this periodically. Discussed with: doceng
* Remove Portsmon referencesDanilo G. Baio2022-04-221-20/+1
| | | | | | | | | | It's been a while since it's not working. The FreeBSD Ports Monitoring System was a good resource for the project; we thank linimon for creating and maintaining it for many years. Approved by: rene (portmgr) Differential Revision: https://reviews.freebsd.org/D35025
* contributing: update The FreeBSD Foundation's mailing addressEd Maste2021-11-111-3/+3
| | | | | | Approved by: ygy (mentor) Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D32949
* Build offline documentation using Hugo and other improvementsSergio Carlavilla Delgado2021-11-031-24/+30
| | | | | | | | | | | | | | | | | | | | | | * Allow to build the documentation offline using Hugo * Fix link problems * Remove SVN entities * Fix lang problems to help weblate * Move all the AsciiDoctor translations to the shared folder to help weblate * Allow the possibility to build each document. For example each document can be edited in and watched the result in real time in VS Code or Vim/NeoVim. Breaking changes: Eliminate the possibility of building books or articles. They must be builded at the same time. This functionality will be restored when version 0.89.0 is in the repositories in a couple of weeks. Reviewed by: dbaio@ Differential Revision: https://reviews.freebsd.org/D31926
* Replace Mailman to Mlmmj addressesDanilo G. Baio2021-10-121-1/+1
| | | | | | | Following mailing lists migration from Mailman to Mlmmj. Reviewed by: bapt Differential Revision: https://reviews.freebsd.org/D32466
* Contributing to ports: encourage using git-format-patch(1) and seeking helpLi-Wen Hsu2021-08-191-2/+3
| | | | | | | Input from: Jose Luis Duran <jlduran@gmail.com>, Pau Amma <pauamma@gundo.com>, bapt Approved by: ygy (mentor) Differential Revision: https://reviews.freebsd.org/D31202
* articles/contributing: Update freebsd-pkg-fallout addressDanilo G. Baio2021-07-021-1/+1
| | | | The former URL is not available anymore.
* Revert "Add Hugo's lang shortcode"Danilo G. Baio2021-06-191-6/+6
| | | | | | | This reverts commit 3462d12db6ebf303064db168a2333374344f369a. Too soon, it broke asciidoctor-pdf which doesn't know Hugo's shortcode. It will take more time and care.
* Add Hugo's lang shortcodeDanilo G. Baio2021-06-191-6/+6
| | | | | | | | | | | | | | | | | | This is a prerequisite for the translation workflow through .po files and Weblate. The asciidoctor include with the shortcode variable will help because won't be needed to change the includes manually after converting the translation (.po file) back to .adoc. It will help other areas like, language attributes, which today is fixed in every document. The use of shortcode was suggested by jmooring@ from Hugo's project on Github. Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D30823
* Change Docbook to AsciiDoc in the contributing article.Warner Losh2021-06-161-1/+1
| | | | | | Also change ASCII to plain text to reflect more recent usage. Sponsored by: Netflix
* Remove an extra space after '+' charactersDanilo G. Baio2021-06-081-21/+21
| | | | | | | | | | | | | This is happening only on documentation/, basically in all places that attaches a block or a paragraph to a list [1]. Although this is working, it impacts our translation tool po4a, the '+' character is a difficult part when processing asciidoc[tor] files. 1 - https://docs.asciidoctor.org/asciidoc/latest/lists/continuation/#list-continuation Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D30688
* en/articles/*: Set includes paths according to the backend used for theMarc Fonvieille2021-05-191-0/+12
| | | | | build. This fixes the PDF versions.
* Improve SEO with the keywors meta tagSergio Carlavilla Delgado2021-05-041-0/+1
| | | | | | Add in all articles and books the tag list. Modify the theme to use the tag list defined in articles and books to generate the keywords meta tag
* Improve descriptions for some books and articlesAllan Jude2021-05-021-1/+2
| | | | | | | | | | Also add weights to some, to define the sort order in the index Put the more commonly used items at the top of their respective lists The improved descriptions were taken from the old books/articles list: https://www.freebsd.org/docs/books/ Sponsored-By: Klara Inc.
* Improve the SEO of the documentation portalSergio Carlavilla Delgado2021-05-011-1/+1
| | | | | | | Changes: - Add the description meta tag in the index, articles and books - Add a brief description in each article and book. - Remove the SVN expansion tag
* articles/contributing: Update ports resourcesDanilo G. Baio2021-04-171-3/+22
| | | | | | | | Add a note that portsmon is currently not working, more visibility to portscout and add new resource portsfallout. Approved by: debdrup (doc) Differential Revision: https://reviews.freebsd.org/D29715
* Fix typos, style and images pathsSergio Carlavilla Delgado2021-03-201-74/+203
| | | | | Global review of styles, typos and images paths in gjournal-desktop, releng, vinum and vm-design
* Use correct syntax markup for shellLi-Wen Hsu2021-03-141-2/+2
| | | | Approved by: carlavilla
* Migrate doc to Hugo/AsciiDoctorSergio Carlavilla Delgado2021-01-251-0/+425
I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-14 19:38:03 +0000