Skip to content

Commit

Permalink
Merge pull request #92 from cloudsecurityalliance/jekyll-website
Browse files Browse the repository at this point in the history
Initial skeleton of Jekyll-based GSD website
  • Loading branch information
joshbuker committed Feb 1, 2023
2 parents 215f8b8 + 914989a commit 61e08d6
Show file tree
Hide file tree
Showing 15 changed files with 230 additions and 0 deletions.
2 changes: 2 additions & 0 deletions website/.bundle/config
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
BUNDLE_PATH: "vendor/bundle"
5 changes: 5 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
_site
.sass-cache
.jekyll-cache
.jekyll-metadata
vendor
25 changes: 25 additions & 0 deletions website/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
permalink: /404.html
layout: default
---

<style type="text/css" media="screen">
.container {
margin: 10px auto;
max-width: 600px;
text-align: center;
}
h1 {
margin: 30px 0;
font-size: 4em;
line-height: 1;
letter-spacing: -1px;
}
</style>

<div class="container">
<h1>404</h1>

<p><strong>Page not found :(</strong></p>
<p>The requested page could not be found.</p>
</div>
26 changes: 26 additions & 0 deletions website/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
source "https://rubygems.org"

gem "jekyll", "~> 4.3.1"
gem "minima", "~> 2.5"

# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
# gem "github-pages", group: :jekyll_plugins
# If you have any plugins, put them here!
group :jekyll_plugins do
# gem "jekyll-feed", "~> 0.12"
end

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", ">= 1", "< 3"
gem "tzinfo-data"
end

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
# do not have a Java counterpart.
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
16 changes: 16 additions & 0 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
This is a [Jeyll](https://jekyllrb.com/)-based website for the Global Security Database documentation.
It is currently in a very initial-state and is based on the default [minima](https://github.com/jekyll/minima) theme.
The [minima](https://github.com/jekyll/minima) GitHub page has detail on how to customize the theme.

## Getting Started

The `.bundle/config` is configured to install Gems in the local directory rather than on your system.
You should be able to build and test this site on your own system using the following commands:

```
bundle install
bundle exec jekyll serve
```

This will start a local webserver for you to browse and test you changes.

30 changes: 30 additions & 0 deletions website/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
title: gsd.id
#email: gsd@groups.cloudsecurityalliance.org
description: >- # this means to ignore newlines until "baseurl:"
The Global Security Database (GSD) is a Working Group project from the Cloud
Security Alliance with the goal of building an open source community for
improving the quality and usabilty of vulnerability databases.
baseurl: "" # the subpath of your site, e.g. /blog
url: "https://gsd.id" # the base hostname & protocol for your site, e.g. http://example.com
#twitter_username: jekyllrb
#github_username: cloudsecurityalliance

# Build settings
theme: minima
#plugins:
# - jekyll-feed

header_pages:
- contribute/index.md
- consume/index.md
- press.md
- about.md

exclude:
- .sass-cache/
- .jekyll-cache/
- gemfiles/
- Gemfile
- Gemfile.lock
- vendor/
- README.md
45 changes: 45 additions & 0 deletions website/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
layout: page
title: About
permalink: /about/
---

The Global Security Database (GSD) is a Working Group project from the [Cloud
Security Alliance](https://cloudsecurityalliance.org/) with the goal of
building an open source community for improving the quality and usabilty of
vulnerability databases.

## Joining

There is a mailing list at
[https://csaurl.org/list-gsd](https://csaurl.org/list-gsd) for general and
technical discussion.

The CSA Circle Community is available at
[https://csaurl.org/circle-gsd](https://csaurl.org/circle-gsd).

## Working Group Recurring Meetings

The GSD Working Group meets every other Tuesday, from 9am-10am Pacific
(12pm-1pm Eastern). To join, please see the "Virtual Meetings" section on the
[working group calendar page](https://cloudsecurityalliance.org/research/working-groups/global-security-database).

## GSD Quick Links

This list is also accessible via the URL
[https://csaurl.org/gsd-quick-links](https://csaurl.org/gsd-quick-links)

* About GSD
* Home Page: [https://globalsecuritydatabase.org](https://globalsecuritydatabase.org)
* Join the working group: [https://csaurl.org/gsd-landing-page](https://csaurl.org/gsd-landing-page)
* WG Meeting Agenda: [https://csaurl.org/gsd-agenda](https://csaurl.org/gsd-agenda)
* Press mentions: [https://globalsecuritydatabase.org/press](https://globalsecuritydatabase.org/press)
* Communication Channels
* Circle Community (Forums): [https://csaurl.org/gsd-circle](https://csaurl.org/gsd-circle)
* Mailing-list: [https://csaurl.org/gsd-mailing-list](https://csaurl.org/gsd-mailing-list)
* Slack: [https://csaurl.org/csa-public-slack](https://csaurl.org/csa-public-slack) #gsd-working-group
* Interact with the data
* GitHub Repos: [https://github.com/cloudsecurityalliance/](https://github.com/cloudsecurityalliance/)
* Request a GSD: [https://requests.globalsecuritydatabase.org/](https://requests.globalsecuritydatabase.org/)
* Edit a GSD entry: [https://edit.globalsecuritydatabase.org/](https://edit.globalsecuritydatabase.org/)

7 changes: 7 additions & 0 deletions website/consume/end-user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
layout: page
title: Consuming GSD Data
---

TODO: add detail

8 changes: 8 additions & 0 deletions website/consume/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: page
title: Consuming GSD Data
---

Why do you want to consume GSD data?
* I want to use data to [secure my systems]({% link consume/end-user.md %}).
* I want to use data and [publish it]({% link consume/publisher.md %}).
7 changes: 7 additions & 0 deletions website/consume/publisher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
layout: page
title: Publishing GSD Data
---

TODO: add detail

18 changes: 18 additions & 0 deletions website/contribute/data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: page
title: Contributing Data to GSD
---

There are two ways to contribute or modify GSD data:
(1) via the website, and
(2) via pull requests.
For small updates, we recommend using the website.
For larger bulk additions, we recommend a pull request (and a heads up).

## Contributing via the Website

TODO: add detail

## Contributing via Pull Requests

TODO: add detail
8 changes: 8 additions & 0 deletions website/contribute/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: page
title: Contributing to GSD
---

How would you like to contribute to GSD?
* I want to contribute or modify [data]({% link contribute/data.md %}).
* I want to contribute or modify [tools]({% link contribute/tools.md %}).
15 changes: 15 additions & 0 deletions website/contribute/tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
layout: page
title: Contributing Tools to GSD
---

GSD tools are publicly available on [GitHub](https://github.com/cloudsecurityalliance/gsd-tools).
We welcome all contributions.

## Helping with Issues

TODO: add text

## Contributing New Tools

TODO: add text
11 changes: 11 additions & 0 deletions website/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
layout: page
title: Global Security Database
---

Vulnerability data has never been more important than it is today, yet the data is not always machine readable, community updatable, or of an acceptable level of quality and completeness. Due to these problems we are seeing every ecosystem create their own bespoke vulnerability database. Vulnerability data has never been more important, or harder to use.

The Global Security Database is addressing these issues in a way that builds community using the open source model. No one organization can be responsible for vulnerability data, it has to be a community effort with community ownership with a strong OpenSource license. The right way isn’t the GSD way, the right way is the open source way. Everyone from developers, companies, and ecosystems should work together to find solutions that work.

The first step in this journey is to build the vulnerability community. If you are interested in working on data, policy, or tooling, please see the getting started guide and dive in!

7 changes: 7 additions & 0 deletions website/press.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
layout: page
title: Press
permalink: /press/
---

TODO: this page lists GSD in the press

0 comments on commit 61e08d6

Please sign in to comment.