Merge pull request #360 - add tab for translations

jgadsden · web-flow · commit fd1b4fbf4896 · 2025-03-14T10:50:39.000Z
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -3,20 +3,27 @@
 Provide a summary for the reviewers of this pull request, stating the section will help
 Please provide enough information so that others can review your pull request
 -->
+If this closes an existing issue then add "closes #xxxx", where xxxx is the issue number
 
 **Description for the changelog** :  
 <!--
 A short (one line) summary that describes the changes in this pull request
 for inclusion in the change log
 -->
 
+**Declaration**:
+
+- [ ] content meets the [license](../license.txt) for this project
+- [ ] any use of AI has been declared in this pull request
+
 **Other info** :  
-<!--
-Add here any other information that may be of help to the reviewer
-If this closes an existing issue then add "closes #xxxx", where xxxx is the issue number
--->
+<!-- Add here any other information that may be of help to the reviewer -->
 
 Thanks for submitting a pull request!
-Please make sure you follow our code_of_conduct.md and our contributing guidelines contributing.md
-Automated tests are run to check the links, markdown and spelling
+
+Please make sure you follow our [Code of Conduct](../code_of_conduct.md)
+and our [contributing guidelines](../contributing.md)
+
+Automated tests are run to check links, markdown and spelling
+
 The pull request must pass these tests before it can be merged
diff --git a/README.md b/README.md
@@ -46,7 +46,7 @@ is via the OWASP Slack [#project-developer-guide][project] project channel
 
 ----
 
-OWASP Developer Guide: _accessible security for developers_
+OWASP DevGuide: _accessible security for developers_
 
 [build]: https://github.com/OWASP/www-project-developer-guide/actions/workflows/ci.yaml
 [conduct]: code_of_conduct.md
diff --git a/contributing.md b/contributing.md
@@ -9,7 +9,7 @@ The project has a team of leaders that oversee the project
 and contributions from members of the security community are positively encouraged.
 
 All contributions and suggestions are certainly welcome, and we ask that
-you follow the [contributing code of conduct][conduct].
+you follow the [contributing Code of Conduct][conduct].
 Contributors can [make suggestions][issues] and provide changes via a [pull request][request].
 
 Feel free to discuss topics in the [project wiki][wiki] and create new discussions.
@@ -18,6 +18,12 @@ Note that the [draft][draft] version provides the content for the released versi
 in the ['release'][release] directory, promoted during the automated release process.
 Therefore any manual changes under the release directory are likely to be over-written.
 
+### Ground rules
+
+* follow our [Code of Conduct](code_of_conduct.md)
+* ensure that all contributions meet the [license](license.txt)
+* the use of generative AI is not prohibited but must be declared in the pull request
+
 ### Philosophy
 
 The Developer Guide does not seek to duplicate the information contained in the many OWASP documentation projects;
diff --git a/index.md b/index.md
@@ -33,8 +33,10 @@ pitch: The Developer Guide allows businesses, developers, designers
 
 The [OWASP Developer Guide](release) provides an introduction to security concepts
 and a handy reference for application and system developers.
+
 This guide does not seek to replicate the many excellent sources on specific security topics;
 it rarely tries to go into detail on a subject and instead provides links for greater depth on these security topics.
+
 The content of the Developer Guide aims to be accessible, introducing practical security concepts
 and providing enough detail to get developers started on various OWASP tools and documents.
 
@@ -65,7 +67,7 @@ is via the OWASP Slack [#project-developer-guide][project] project channel (you
 
 ----
 
-OWASP Developer Guide: _accessible security for developers_
+OWASP DevGuide: _accessible security for developers_
 
 [conduct]: code_of_conduct.md
 [contribution]: contributing.md
diff --git a/info.md b/info.md
@@ -14,6 +14,12 @@
 * Released [PDF][pdf] and [e-book][epub]
 * [Draft version](draft)
 
+### Translations (in progress)
+
+* [Brazilian Portuguese](release-pt-br)
+* [Spanish](release-es)
+* [Japanese](release-ja)
+
 ### License
 
 * [![Creative Commons License][license-image]](https://creativecommons.org/licenses/by-sa/4.0/ "CC BY-SA 4.0")
diff --git a/release-process.md b/release-process.md
@@ -37,4 +37,6 @@ using the wording from the previous releases as a guide to the release notes.
 
 ----
 
+OWASP DevGuide: _accessible security for developers_
+
 [release]: https://github.com/OWASP/www-project-developer-guide/releases
diff --git a/security.md b/security.md
@@ -10,4 +10,8 @@ then let us know ASAP and we will fix it as a priority.
 Open a [security advisory][advisory] and this will be provided
 only to the project's admins and in strict confidence.
 
+----
+
+OWASP DevGuide: _accessible security for developers_
+
 [advisory]: https://github.com/OWASP/www-project-developer-guide/security/advisories/new
diff --git a/tab_contributing.md b/tab_contributing.md
@@ -36,6 +36,10 @@ If you feel a section is missing then suggest changes to the structure in a [fea
 Be sure to follow our [code of conduct][conduct] and the [contributing guidelines][contribute]
 which provide style and document structure suggestions.
 
+----
+
+OWASP DevGuide: _accessible security for developers_
+
 [conduct]: https://github.com/OWASP/www-project-developer-guide/blob/main/code_of_conduct.md
 [contribute]: https://github.com/OWASP/www-project-developer-guide/blob/main/contributing.md
 [feature]: https://github.com/OWASP/www-project-developer-guide/issues/new/choose
diff --git a/tab_historical.md b/tab_historical.md
@@ -3,7 +3,7 @@
 title: Historical
 layout: null
 tab: true
-order: 2
+order: 3
 tags: dev-guide, developer guide
 
 ---
@@ -71,6 +71,10 @@ which discusses the history and future of the project.
 We are still looking for the original Word documents for versions 1.x (1.0, 1.1 and 1.1.1),
 if you have any of these then please get in touch.
 
+----
+
+OWASP DevGuide: _accessible security for developers_
+
 [guide-1v0]: https://github.com/OWASP/DevGuide/tree/1d24d140de3724b6f95655e53b8d0cc6689fbfd8/DevGuide1.0
 [guide-pdf-en-1v0]: https://github.com/OWASP/DevGuide/blob/1d24d140de3724b6f95655e53b8d0cc6689fbfd8/DevGuide1.0/OWASPBuildingSecureWebApplicationsAndWebServices-V1.0.pdf
 [guide-1v1]: https://github.com/OWASP/DevGuide/tree/22228a88e380ca4b0b88cbb959b32a11174263cd/DevGuide1.1
diff --git a/tab_translations.md b/tab_translations.md
@@ -0,0 +1,43 @@
+---
+
+title: Translations
+layout: null
+tab: true
+order: 2
+tags: dev-guide, developer guide
+
+---
+
+<style type="text/css">
+.image-right {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+  float: right;
+  height: 180px;
+}
+</style>
+
+![developer guide logo](assets/images/dg_logo_di.png){: .image-right }
+
+## Translations the Developer Guide
+
+The OWASP Developer Guide aims to be accessible, and translations help to make is a useful resource
+for the global AppSec community.
+
+The English (US) language version is the source for all the translations;
+the latest version can be found in the [releases][repo] repository.
+
+At present (March 2025) there are some translations that are in progress:
+
+* [Brazilian Portuguese](release-pt-br) lead translator Amauri Bizerra
+* [Spanish](release-es) lead translator Roxana Calderon
+* [Japanese](release-ja) lead translator Yuuki Ebihara
+
+If you can help with these translations then please contact the lead translator or the DevGuide project leaders.
+
+----
+
+OWASP DevGuide: _accessible security for developers_
+
+[repo]: https://github.com/OWASP/www-project-developer-guide/releases
