Skip to content

Commit

Permalink
adjust urls and add stub for PMP
Browse files Browse the repository at this point in the history
  • Loading branch information
Schpidi committed Dec 12, 2023
1 parent 9aa8d92 commit 937648c
Show file tree
Hide file tree
Showing 21 changed files with 999 additions and 7 deletions.
20 changes: 20 additions & 0 deletions documents/PMP/01.introduction/00.introduction.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

= Introduction

== Purpose and Scope

This document represents the Project Management Plan (PMP) for the {component-name} project. This document describes <TBD>

== Structure of the Document

Section 2 - <<mainOverview>>::
This section provides an overview of the {project} {component-name}

Section 3 - <<mainDesign>>::
<TBD>

include::03.reference-docs.adoc[leveloffset=+1]

include::04.terminology.adoc[leveloffset=+1]

include::05.glossary.adoc[leveloffset=+1]
20 changes: 20 additions & 0 deletions documents/PMP/01.introduction/03.reference-docs.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

= Reference Documents

The following is a list of Applicable and Reference Documents with a direct bearing on the content of this document.

[cols="2,7a,2a"]
|===
| Reference | Document Details | Version

| [SOW]
| Statement of Work Destination Earth DESP Use Cases selection - Round 1 +
Reference: CS301353.Docref.0002
| 1.0

| [Proposal]
| Proposal No. 8482: DestinE Sea Ice Decision Enhancement (DESIDE)
| 1.1 +
06/06/2023

|===
55 changes: 55 additions & 0 deletions documents/PMP/01.introduction/04.terminology.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@

= Terminology

The following terms have been used in this document.

[cols="1,3"]
|===
| Term | Meaning

| Admin
| User with administrative capabilities on a platform.

| Code
| The codification of an algorithm performed with a given programming language - compiled to Software or directly executed (interpreted) within the platform.

| Discovery
| User finds products/services of interest to them based upon search criteria.

| Interactive Web Application
| An Interactive Application for analysis provided as a rich user interface through the user's web browser.

| Key-Value Pair
| A key-value pair (KVP) is an abstract data type that includes a group of key identifiers and a set of associated values. Key-value pairs are frequently used in lookup tables, hash tables and configuration files.

| Object Store
| A computer data storage architecture that manages data as objects. Each object typically includes the data itself, a variable amount of metadata, and a globally unique identifier.

| Products
| EO data (commercial and non-commercial) and Value-added products.

| Software
| The compilation of code into a binary program to be executed within the platform on-line computing environment.

| User
| An individual using the services.

| Visualization
| To obtain a visual representation of any data/products held within the platform - presented to the user within their web browser session.

| Web Coverage Service (WCS)
| OGC standard that provides an open specification for sharing raster datasets on the web.

| Web Feature Service (WFS)
| OGC standard that makes geographic feature data (vector geospatial datasets) available on the web.

| Web Map Service (WMS)
| OGC standard that provides a simple HTTP interface for requesting geo-registered map images from one or more distributed geospatial databases.

| Web Map Tile Service (WMTS)
| OGC standard that provides a simple HTTP interface for requesting map tiles of spatially referenced data using the images with predefined content, extent, and resolution.

| Web Processing Services (WPS)
| OGC standard that defines how a client can request the execution of a process, and how the output from the process is handled.

|===
45 changes: 45 additions & 0 deletions documents/PMP/01.introduction/05.glossary.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@

= Glossary

The following acronyms and abbreviations have been used in this document.

[cols="1,6"]
|===
| Term | Definition

| ADD | Architecture Design Document
| AOI | Area of Interest
| API | Application Programming Interface
| COG | Cloud optimized GeoTiff
| EO | Earth Observation
| EOX | EOX IT Services GmbH
| ESA | European Space Agency
| FUSE | Filesystem in Userspace
| ICD | Interface Control Document
| JSON | JavaScript Object Notation
| KVP | Key-value Pair
| M2M | Machine-to-machine
| OGC | Open Geospatial Consortium
| PMP | Project Management Plan
| REST | Representational State Transfer
| SDD | Software Design Document
| SFTP | Secure File Transfer Protocol
| SRF | Software Reuse File
| SRN | Software Release Note
| SRP | Software Release Plan
| SRS | Software Requirements Specification
| SSH | Secure Shell
| STAC | Spatio-Temporal Asset Catalog
| SUM | Software User Manual
| SVVP | Software Verification and Validation Plan
| SVVR | Software Verification and Validation Report
| TOI | Time of Interest
| UMA | User-Managed Access
| US | User Story
| WCS | Web Coverage Service
| WFS | Web Feature Service
| WMS | Web Map Service
| WMTS | Web Map Tile Service
| WPS | Web Processing Service
| WPS-T | Transactional Web Processing Service
|===
4 changes: 4 additions & 0 deletions documents/PMP/02.overview/00.overview.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[[mainOverview]]
= Overview

This section provides an overview of the {project} {component-name}. It highlights ...
17 changes: 17 additions & 0 deletions documents/PMP/amendment-history.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

'''

AMENDMENT HISTORY::
This document shall be amended by releasing a new edition of the document in its entirety. +
The Amendment Record Sheet below records the history and issue status of this document.
+
.Amendment Record Sheet
[cols="^1h,^2,<5"]
|===
| ISSUE | DATE | REASON

| 0.1 | 10/12/2023 | Initial in-progress draft
| 1.0 | | First released version
|===

'''
3 changes: 3 additions & 0 deletions documents/PMP/end-of-document.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@

[.large]
<< End of Document >>
Binary file added documents/PMP/images/DESIDE.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 54 additions & 0 deletions documents/PMP/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
:doctype: book
:author: PolarView Team
:email: <TBD>
:project: DESIDE
:project-name: {project}
:component-name: DESIDE
:component-github-name: https://github.com/destination-earth/DestinE_ESA_DESIDE/documents
:component-github-pages: https://destination-earth.github.io/DestinE_ESA_DESIDE/
:doc-title: Project Management Plan
:doc-num: D-XXX
:revnumber: 0.1
:revdate: 10/12/2023
// :revremark:
:category:
:copyrightYear: 2023
// attributes
:sectnums:
:sectnumlevels: 5
:toc: left
:toclevels: 5
:toc-title: {project} - {doc-title}
:description:
:keywords:
:imagesdir: ./images
:linkcss:
:stylesdir: stylesheets
:stylesheet: custom.css
:icons: font
:source-highlighter: coderay
// pdf
:pdf-stylesdir: resources/themes
:pdf-style: custom
:media: screen
:title-logo-image: image::DESIDE.png[top=5%, align=right]

= {doc-title}: {doc-num}

:leveloffset: +1

include::preface.adoc[]

<<<

include::01.introduction/00.introduction.adoc[]

<<<

include::02.overview/00.overview.adoc[]

'''

include::end-of-document.adoc[]

:leveloffset: -1
22 changes: 22 additions & 0 deletions documents/PMP/preface.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

{project-name}
_{doc-title}_
{doc-num}

[cols="^1,^1"]
|===
| *COMMENTS and ISSUES* +
If you would like to raise comments or issues on this document, send an email to {email}.
| *PDF*
This document is available in PDF format link:{component-github-pages}/index.html[here^].
| *EUROPEAN SPACE AGENCY CONTRACT REPORT* +
The work described in this report was done under ESA contract. Responsibility for the
contents resides in the author or organization that prepared it.
| *EOX IT Services GmbH* +
Thurngasse 8/4, 1090 Vienna, Austria. +
http://eox.at/[eox.at]
|===

include::amendment-history.adoc[]

<<<
28 changes: 28 additions & 0 deletions documents/PMP/resources/themes/custom-theme.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
extends: origdefault
base:
font_color: 000000
running_content:
start_at: title
footer:
height: $base_line_height_length * 4
columns: "<45% =10% >45%"
# odd
recto:
left:
content: |
{project} +
{doc-title}
center:
content: '{page-number}'
right:
content: |
{doc-num} +
Issue {revnumber}
# even
verso:
left:
content: $footer_recto_right_content
center:
content: $footer_recto_center_content
right:
content: $footer_recto_left_content
Loading

0 comments on commit 937648c

Please sign in to comment.