Skip to content

Commit

Permalink
Add more content to main landing page (#37)
Browse files Browse the repository at this point in the history
* Moved purpose, motivation, scope to homepage of RtD
  • Loading branch information
bourque authored Sep 26, 2024
1 parent 9d58882 commit c724c1d
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 45 deletions.
45 changes: 3 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,12 @@
# developer-guide

This repository provides guidelines for software developers at LASP. You can view the developer guide here: http://lasp-developer-guide.readthedocs.io/

## Purpose

The purpose of this repository is to provide a collection of documented guidelines for software development workflows
and processes commonly used within Data Systems in order to assist developers in accomplishing their work. The developer
guide is managed within this version-controlled GitHub repository as to allow for the collaborative creation and
maintenance of the guidelines.

## Motivation

The motivation for this effort is two-fold:
- We are motivated by [Goal 3.1](https://confluence.lasp.colorado.edu/display/DS/2024-2027+Data+Systems+Strategic+Plan#id-20242027DataSystemsStrategicPlan-goal3)
from the 2024-2027 Data Systems Strategic Plan, which states "Create a set of living DS best practices and training
guides that include standard processes and expectations for common tasks".
- With the push towards open science and access (see [NASA’s directive SPD-41a](https://science.nasa.gov/researchers/open-science/science-information-policy/))
we hope to also embody this openness in our internal processes.

Historically, such documentation has been spread over multiple pages and spaces within confluence and specific projects.
The developer guide endeavors to bring these resources together in one centralized space, allowing for collaboration
across individuals and teams. We can collectively determine "how we work best" and document such guidelines in a
version-controlled repository with access to the collaborative tools that GitHub provides.

Through this guide, we seek to promote a culture of continuous improvement, where feedback is encouraged, and processes
are regularly reviewed and updated to reflect evolving industry standards and emerging technologies - this is a living
document.

Another goal to provide an equal footing for all people, regardless of their background and skill levels. Having
accessible, well-documented guidelines available to all people associated with the lab is a way to ensure all employees
(and students), regardless of background, have the same access to information. The lack of diversity within the fields
represented in Data Systems can be accounted for, in part, by how accessible - or not - the fields are. Prohibitive
costs, dearth of mentorship, strict mores and norms (think: expectations when finding an advisor or going to a
conference), and equal access to information all play a part in this overall accessibility. We can start to address
the last item on the list within our own workplace. In building this developer guide, we hope to create a successful
start for those new to the job or learning new skills.

## Scope

The developer guide aims to provide guidelines and recommendations, not mandates. It also aims to provide information
in a non-redundant way, and avoid re-writing what may already be well-documented somewhere on the internet. Instead of
describing a topic in detail, the developer guide attempts to answer the question -- "How do I apply this concept in the
context of my work in Data Systems?"
This repository contains the source code for the LASP developer guide. For more information about purpose, motivation,
scope, and contents, see the developer guide here: http://lasp-developer-guide.readthedocs.io/.

## Contributing

If you would like to contribute changes to the content of this repository, do the following:

1. Create a fork of this repository
2. Make a local clone of your fork:

Expand Down
51 changes: 48 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,52 @@
LASP Developer's Guide
======================

Welcome to the LASP Developer's Guide!
======================================

Purpose
-------

The purpose of this website is to provide a collection of documented guidelines for software development workflows and
processes commonly used within Data Systems in order to assist developers in accomplishing their work. The developer
guide is managed within a version-controlled `GitHub repository <https://github.com/lasp/developer-guide>`_ as to allow
for the collaborative creation and maintenance of the guidelines.

Motivation
----------

The motivation for this effort is two-fold:
- We are motivated by `Goal 3.1 <https://confluence.lasp.colorado.edu/display/DS/2024-2027+Data+Systems+Strategic+Plan#id-20242027DataSystemsStrategicPlan-goal3>`_
from the 2024-2027 Data Systems Strategic Plan, which states "Create a set of living DS best practices and training
guides that include standard processes and expectations for common tasks".
- With the push towards open science and access (see `NASA’s directive SPD-41a <https://science.nasa.gov/researchers/open-science/science-information-policy>`_)
we hope to also embody this openness in our internal processes.

Historically, such documentation has been spread over multiple pages and spaces within confluence and specific projects.
The developer guide endeavors to bring these resources together in one centralized space, allowing for collaboration
across individuals and teams. We can collectively determine "how we work best" and document such guidelines in a
version-controlled repository with access to the collaborative tools that GitHub provides.

Through this guide, we seek to promote a culture of continuous improvement, where feedback is encouraged, and processes
are regularly reviewed and updated to reflect evolving industry standards and emerging technologies - these are a living
documents!

Another goal to provide an equal footing for all people, regardless of their background and skill levels. Having
accessible, well-documented guidelines available to all people associated with the lab is a way to ensure all employees
(and students), regardless of background, have the same access to information. The lack of diversity within the fields
represented in Data Systems can be accounted for, in part, by how accessible - or not - the fields are. Prohibitive
costs, dearth of mentorship, strict mores and norms (think: expectations when finding an advisor or going to a
conference), and equal access to information all play a part in this overall accessibility. We can start to address
the last item on the list within our own workplace. In building this developer guide, we hope to create a successful
start for those new to the job or learning new skills.

Scope
-----

The developer guide aims to provide guidelines and recommendations, not mandates. It also aims to provide information
in a non-redundant way, and avoid re-writing what may already be well-documented somewhere on the internet. Instead of
describing a topic in detail, the developer guide attempts to answer the question -- *"How do I apply this concept in
the context of my work in Data Systems?"*

Contents
--------

.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit c724c1d

Please sign in to comment.