Skip to content

Commit

Permalink
add schema to site documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pahjbo committed Oct 21, 2024
1 parent 2d7dae8 commit 4ec8476
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 1 deletion.
8 changes: 8 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,20 @@ tasks.register<Copy>("copyJavaDocForSite") {

}

tasks.register<Copy>("copySchemaForSite") {
from(layout.buildDirectory.dir("generated/sources/vodml/schema"))
into(vodml.outputSiteDir.dir("schema"))
dependsOn("vodmlSchema")

}

tasks.register<Exec>("makeSiteNav")
{
commandLine("yq","eval", "(.nav | .. |select(has(\"AutoGenerated Documentation\"))|.[\"AutoGenerated Documentation\"]) += load(\"docs/generated/allnav.yml\")", "mkdocs_template.yml")
standardOutput= file("mkdocs.yml").outputStream()
dependsOn("vodmlSite")
dependsOn("copyJavaDocForSite")
dependsOn("copySchemaForSite")

}
tasks.register<Exec>("testSite"){
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Main Concepts
=============

A [Principal Investigator](../generated/proposal/Person/) is interested in one or more [Targets](../generated/proposal/Target/) and they decide that they want to create an [Observing Proposal](../generated/proposal/ObservingProposal/) to study them. They write a [Science Justification](../generated/proposal/Justification/) to try to persuade the [Time Allocation Committee](../generated/proposalManagement/TAC/) for a particular [Observatory](../generated/proposal/Observatory/) to allocate some [Observations](../generated/proposal/Observation/) on one or more [Telescopes](../generated/proposal/Telescope/) that they operate.
A [Principal Investigator](../generated/proposal/Person/) is interested in one or more [Targets](../generated/proposal/Target/) and they decide that they want to create an [Observing Proposal](../generated/proposal/ObservingProposal/) to study them. They write a [Science Justification](../generated/proposal/Justification/) to try to persuade the [Time Allocation Committee](../generated/proposalManagement/TAC/) for a particular [Observatory](../generated/proposalManagementproposalManagement/Observatory/) to allocate some [Observations](../generated/proposal/Observation/) on one or more [Telescopes](../generated/proposalManagement/Telescope/) which they operates These telescopes might form a [TelescopeArray](../generated/proposalManagement/TelescopeArray/ ) which acts in unison.



Expand Down
14 changes: 14 additions & 0 deletions docs/schema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Schema
======

The schema that can be used for validating model instances are

* XML Schema

- [proposal](generated/schema/proposaldm.vo-dml.xsd){:download=proposaldm.vo-dml.xsd)}
- [propsalManagement](generated/schema/proposalManagement.vo-dml.xsd){:download=proposalManagement.vo-dml.xsd}

* JSON Schema

- [proposal](generated/schema/proposaldm.vo-dml.json){:download=proposaldm.vo-dml.json}
- [proposalManagement](generated/schema/proposalManagement.vo-dml.json){:download=proposalManagement.vo-dml.json}
2 changes: 2 additions & 0 deletions mkdocs_template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ theme:
markdown_extensions:
- tables
- footnotes
- attr_list
- pymdownx.superfences:
custom_fences:
- name: mermaid
Expand All @@ -23,5 +24,6 @@ nav:
- Introduction: usecases/intro.md
- Telescopes: usecases/telescopeDescriptions.md
- Observations: usecases/observationDescriptions.md
- Schema: schema.md
- AutoGenerated Documentation:
- JavaDoc: generated/javadoc/index.html

0 comments on commit 4ec8476

Please sign in to comment.