Skip to content

Commit

Permalink
initial draft of repo organization
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidRies committed Mar 13, 2018
0 parents commit 68c0400
Show file tree
Hide file tree
Showing 136 changed files with 92,410 additions and 0 deletions.
106 changes: 106 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
*.DS_Store

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class



# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/
guidelines/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# dotenv
.env

# virtualenv
.venv
venv/
ENV/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
20 changes: 20 additions & 0 deletions guidelines/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = OVALCommunity
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
82 changes: 82 additions & 0 deletions guidelines/_templates/breadcrumbs.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}

{% if page_source_suffix %}
{% set suffix = page_source_suffix %}
{% else %}
{% set suffix = source_suffix %}
{% endif %}

{% if meta is defined and meta is not none %}
{% set check_meta = True %}
{% else %}
{% set check_meta = False %}
{% endif %}

{% if check_meta and 'github_url' in meta %}
{% set display_github = True %}
{% endif %}

{% if check_meta and 'bitbucket_url' in meta %}
{% set display_bitbucket = True %}
{% endif %}

{% if check_meta and 'gitlab_url' in meta %}
{% set display_gitlab = True %}
{% endif %}

<div role="navigation" aria-label="breadcrumbs navigation">

<ul class="wy-breadcrumbs">
{% block breadcrumbs %}
<li><a href="{{ pathto(master_doc) }}">{{ _('The Guidelines') }}</a> &raquo;</li>
{% for doc in parents %}
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
{% endfor %}
<li>{{ title }}</li>
{% endblock %}
{% block breadcrumbs_aside %}
<li class="wy-breadcrumbs-aside">
{% if pagename != "search" %}
{% if display_github %}
{% if check_meta and 'github_url' in meta %}
<!-- User defined GitHub URL -->
<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% else %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% endif %}
{% elif display_bitbucket %}
{% if check_meta and 'bitbucket_url' in meta %}
<!-- User defined Bitbucket URL -->
<a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
{% else %}
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
{% endif %}
{% elif display_gitlab %}
{% if check_meta and 'gitlab_url' in meta %}
<!-- User defined GitLab URL -->
<a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
{% else %}
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/blob/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
{% endif %}
{% elif show_source and source_url_prefix %}
<a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a>
{% elif show_source and has_source and sourcename %}
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
{% endif %}
{% endif %}
</li>
{% endblock %}
</ul>

{% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
{% if next %}
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
{% endif %}
{% if prev %}
<a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
{% endif %}
</div>
{% endif %}
<hr/>
</div>
14 changes: 14 additions & 0 deletions guidelines/additional-resources.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Additional Resources
=====================

Intro TBD.

Resources
---------

Listing of resources (oval projects, related standards, etc.)

Updating the List
-----------------

Instructions to join, change, remove from this list.
19 changes: 19 additions & 0 deletions guidelines/community-organization/area-supervisors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Area Supervisors
=====================

Description of role.

Area Supervisors
----------------

List of supervisors/areas.

Responsibilities
----------------

General info about area supervisor responsibilities.

Appointment
-----------

Info on appointment/change processes.
9 changes: 9 additions & 0 deletions guidelines/community-organization/community-members.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Community Members
=================

Description of role.

Join Us
-------

Invitation to join community with suggestions (join the mailing list, raise issues, etc.)
24 changes: 24 additions & 0 deletions guidelines/community-organization/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Community Organization
======================

Welcoming intro TBD.

How the Community Works
-----------------------

The OVAL Community includes:

* Community Members: brief description and link into Community Member page.
* The OVAL Leadership Board: brief description and link into The OVAL Leadership Board page.
* Area Supervisors: brief description and link into Area Supervisors page.
* OVAL Sponsor: brief description and link into OVAL Sponsor page.

.. toctree::
:caption: Community Organization
:maxdepth: 2
:hidden:

community-members
oval-leadership-board
area-supervisors
oval-sponsor
19 changes: 19 additions & 0 deletions guidelines/community-organization/oval-leadership-board.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
OVAL Leadership Board
=====================

Description of role.

Leadership Board Members
------------------------

List of members.

Responsibilities
----------------

General info about responsibilities.

Appointment
-----------

Info on appointment/change processes.
19 changes: 19 additions & 0 deletions guidelines/community-organization/oval-sponsor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
OVAL Sponsor
============

Description of role.

Sponsor
-------

CIS is sponsor, etc.

Responsibilities
----------------

General info about sponsor responsibilities.

Appointment
-----------

Info on appointment/change processes.
Loading

0 comments on commit 68c0400

Please sign in to comment.