readme page leads to DevGuide project

Author: jgadsden

README.md

@@ -1,17 +1,30 @@
-## This repository has been migrated to [OWASP/www-project-developer-guide][owaspdevguide]
+## OWASP Foundation Developer Guide
 
-OWASP has moved to a 'web first' philosophy and moving away from downloads.
-We will still be providing PDF and ePub, but the emphasis will be on providing web page documents.
+The Developer Guide is one of the original documents from OWASP and so has a long history.
+The original DevGuide repository has many of the [previous versions][versions]
+going back to the [very first version 1.0][original] release from 2002.
 
-The [OWASP project page][owaspdevguide] is at present the source of the OWASP Developer Guide document.
+This is the content for the Developer Guide document, the [DevGuide repository][devguide],
+the latest version of this guide is accessible as a [web document][latest].
 
-If you have forked this repo, note that [the default branch has been renamed][FAQ1] to `main`.
+The content for the OWASP Developer Guide [project pages][project-pages] is in its own [repo][project-repo].
+
+### Contributing
+
+Contributions and suggestions for the Developer Guide are all welcome;
+make a start by reading the [contributing guidelines][guide] and follow the [contributing code of conduct][conduct].
+
+For other contributions to these pages please [create an issue][issues] or open a [pull request][request].
 
-## Contributing
+The easiest way to get in contact with the development community for this documentation project
+is via the OWASP Slack [#project-developer-guide][project] project channel
+(you may need to [subscribe](https://owasp.org/slack/invite) first).
 
 [The wiki][wiki] contains more information about the project's background and purpose.
 
-## Contact
+If you have forked this repo, note that [the default branch has been renamed][FAQ1] to `main`.
+
+### Project leaders / editors
 
 The DevGuide leaders are:
 
@@ -21,6 +34,20 @@ The DevGuide leaders are:
 * [Harold Blankenship](mailto:[email protected])
 * [Jon Gadsden](mailto:[email protected])
 
+----
+
+OWASP DevGuide: _accessible security for developers_
+
 [FAQ1]: https://github.com/OWASP/DevGuide/wiki/FAQs#the-default-branch-has-been-renamed
-[owaspdevguide]: https://owasp.org/www-project-developer-guide/
+[conduct]: https://github.com/OWASP/DevGuide/blob/main/code_of_conduct.md
+[devguide]: https://github.com/OWASP/DevGuide
+[guide]: https://github.com/OWASP/DevGuide/blob/main/contributing.md
+[issues]: https://github.com/OWASP/DevGuide/issues/new/choose
+[latest]: https://devguide.owasp.org/
+[original]: https://github.com/OWASP/DevGuide/blob/1d24d140de3724b6f95655e53b8d0cc6689fbfd8/DevGuide1.0/OWASPBuildingSecureWebApplicationsAndWebServices-V1.0.pdf
+[project]: https://owasp.slack.com/messages/C04QN6CMNAC
+[project-pages]: https://owasp.org/www-project-developer-guide/
+[project-repo]: https://github.com/OWASP/www-project-developer-guide
+[request]: https://github.com/OWASP/DevGuide/pulls
+[versions]: https://github.com/OWASP/DevGuide/wiki#old-versions
 [wiki]: https://github.com/OWASP/DevGuide/wiki

contributing.md

@@ -16,10 +16,6 @@ Contributors can [make suggestions][issues] and provide changes via a [pull requ
 
 Feel free to discuss topics in the [project wiki][wiki] and create new discussions.
 
-Note that the [draft][draft] version provides the content for the released version of Developer Guide,
-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)
@@ -96,9 +92,8 @@ The pull requests have checks applied to them:
 
 1. Link checker for any broken links; if there is an imperative for a broken link then add it to `.lycheeignore`
 2. Markdown lint that ensures the markdown is consistent and valid
-3. Spell checker; new words that are not recognized can be added to `/.wordlist.txt`
+3. Spell checker; new words that are not recognized should be added to `/.wordlist.txt`
 
-if all these checks pass then both the PDF and ePub versions of the guide are provided as github artifacts.
 
 ### Running checks locally
 
@@ -108,24 +103,6 @@ To run these checks locally before pushing a commit, run these commands from the
 1. Link checker: `lychee --max-retries 5 --exclude-path './_includes/*.html' './**/*.md'`
 2. Markdown linter: `markdownlint-cli2  **/*.md`
 3. Spell checker: `pyspelling --config .spellcheck-en.yaml` (for english)
-4. commands to set up the environment for PDF and ePub export
-
-```text
-mkdir draft/temp
-mkdir assets/images/logos/publish
-export RESOURCE_PATH="draft/assets/images:draft/assets:draft:assets/images/logos:assets/images:assets/images/logos/publish"
-```
-
-and the commands to create PDF and ePub outputs:
-
-```text
-tail -n +14 -q $(find draft -name "*[0-9]*.md" | sort) > draft/temp/draft.markdown
-sed -i "s/{: .image-right }/{height=180px}/g" draft/temp/draft.markdown
-pandoc -f markdown -o draft.pdf --resource-path="$RESOURCE_PATH" \
--fmarkdown-implicit_figures draft/title.pdf.yaml draft/temp/draft.markdown
-pandoc -f markdown -o draft.epub --resource-path="$RESOURCE_PATH" \
--fmarkdown-implicit_figures draft/title.yaml draft/temp/draft.markdown
-```
 
 Follow instructions to install the command line [lychee][lychee-install] and [pandoc][pandoc-install].
 
@@ -174,13 +151,11 @@ OWASP DevGuide: _accessible security for developers_
 
 [asvs]: https://owasp.org/www-project-application-security-verification-standard/
 [conduct]: code_of_conduct.md
-[draft]: draft
 [issues]: https://github.com/OWASP/DevGuide/issues/new/choose
 [lychee-install]: https://lychee.cli.rs/
 [media]: https://drive.google.com/drive/folders/1Ft8Ll0cgw0TIoub6aXTIJDmy0sk1RarU
 [pandoc-install]: https://pandoc.org/installing.html
 [project]: https://owasp.org/www-project-developer-guide/
-[release]: release
 [request]: https://github.com/OWASP/DevGuide/pulls
 [wiki]: https://github.com/OWASP/DevGuide/wiki
 [wstg]: https://owasp.org/www-project-web-security-testing-guide/

docs/index.md

@@ -63,9 +63,9 @@ The OWASP Developer Guide is a community effort; if there is something that need
 then [submit an issue][issue03] or [edit on GitHub][edit03].
 
 [about]: https://owasp.org/about/
-[edit03]: https://github.com/OWASP/DevGuide/blob/main/docs/03-introduction.md
+[edit03]: https://github.com/OWASP/DevGuide/blob/main/docs/index.md
 [intstand]: https://owasp.org/www-project-integration-standards/
-[issue03]: https://github.com/OWASP/DevGuide/issues/new?labels=enhancement&template=request.md&title=Update:%2003-introduction
+[issue03]: https://github.com/OWASP/DevGuide/issues/new?labels=enhancement&template=request.md&title=Update:%2001-introduction
 [opencrechat]: https://www.opencre.org/chatbot
 [samm]: https://owaspsamm.org/about/
 [versions]: https://github.com/OWASP/DevGuide/wiki#old-versions