diff --git a/.gitignore b/.gitignore index aebfec79a..cb7e16977 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ _site .idea/ +.vscode/ *.iml diff --git a/Logistics/Summit-site.md b/Logistics/Summit-site.md new file mode 100644 index 000000000..26304ee99 --- /dev/null +++ b/Logistics/Summit-site.md @@ -0,0 +1,37 @@ +--- +layout: default +title: Summit Site +type: logistic +--- + + +## Summit Site + +This page contains details about how the [http://owaspsummit.org](http://owaspsummit.org) site works + +### jekyll based + +The site is a static generated website with no javascript and built using [jekyll](https://jekyllrb.com) + +This works great because GitHub has [native support for jekyll](https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/) + +The [http://owaspsummit.org](http://owaspsummit.org) site is rebuild within seconds of a Git Push or Merge (into master branch of [owasp-summit-2017](https://github.com/OWASP/owasp-summit-2017) repository) + +You can also easily run the site locally (good when making large set of changes) using: ```jekyll serve```. This will generate the site into the ```_site``` folder (ignored by git) which can be browsed locally at [http://127.0.0.1:4000/](http://127.0.0.1:4000/) + +### Help needed!!! + +We are currently looking for help in improving the design and content of this site, so if you have some spare cycles, please help out :) + +### Notes to editors + +If you are creating content to be added for this site, here are some notes/tips: + +- To submit changes: + - Fork the OWASP Summit 2017 [repository](https://github.com/OWASP/owasp-summit-2017) + - Make as many changes and updates as you want + - Submit changes as Pull Requests + - (if you want to share/view immediately your changes you can setup a GitHub site for your fork) +- After summiting the PR, please drop a message in the [#owasp-summit-2017](https://owasp.slack.com/archives/owasp-summit-2017) Slack channel +- If your changes have not been merged within a couple hours/days feel free to drop a note direct to [Bjoern](bjoern.kimminich@owasp.org), [Dinis](dinis.cruz@owasp.org) or [Seba](seba@owasp.org) +- When creating links between pages, please link to the HTML page in the owaspsummit.org site (i.e. don't link to the GitHub page)