Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

final EML 2.2 documentation cleanup #340

Closed
mbjones opened this issue Jul 24, 2019 · 7 comments
Closed

final EML 2.2 documentation cleanup #340

mbjones opened this issue Jul 24, 2019 · 7 comments
Assignees
Labels
Milestone

Comments

@mbjones
Copy link
Contributor

@mbjones mbjones commented Jul 24, 2019

  • Create and configure domain name for https://eml.ecoinformatics.org
  • Decide where the validation service will run, and set it up
    • Fix link in section 9.4 to the parser
  • Review ecoinfo charter and governance language in README
  • Discuss deprecating the eml-access module
  • Issue a DOI and update README
  • Add bibtex citation for copying
  • Create much simpler intro to semantic annotations, with human readable language
  • Fix footnote language in 10.6 sem-primer
  • Update release notes in section 12
  • Update contributors to include Chong
  • Embed links to schema docs in book
  • add a CodeMeta.json file describing the release
  • determine if we can eliminate com.oreilly.servlet and its LICENSE restrictions
@mbjones mbjones added this to the EML2.2.0 milestone Jul 24, 2019
@mbjones mbjones self-assigned this Jul 24, 2019
@mobb

This comment has been minimized.

Copy link
Contributor

@mobb mobb commented Jul 25, 2019

semantic primer TO DOs:

  1. add section numbers (letters?)
  • A. Introduction
  • B. Semantics annotations in EML 2.2
  • C. Appendix
    A reader should be able to create an EML annotation with examples, etc in section B alone (which currently is about half the total pages). Section C is for more in-depth info if they want it.
  1. It should also be obvious to readers that they will need to have some external vocabs recommended. We have not come out and said that anywhere. nor have we started on a list recommendations, except de facto (in examples). My current feeling is that we add our example onts to the glossary (or appendix sub-section titled "Vocabs in examples"), but save formal recommendations for a separate doc.

  2. enhance sub-section "organization of this doc" . describe A, B, C sections.

  3. In each example's intro paragraph, use a list to highlight the three parts of the semantic statement. move parentheticals about external vocabs to appendix

  4. introduce the "semantic statement" (plain english, no tech) right after the first code block showing an annotation node (on p2). link to below (addresses SC's comment).

  5. add these terms to glossary (or other appendix section), link in text as much as possible:

  • knowledge graph
  • controlled vocabulary
  • dereference
  • subclass
  • semantic statement
  • Information Artifact Ontology (or section titled vocabs in examples)
  • Envo (or section titled vocabs in examples)
mobb added a commit that referenced this issue Jul 25, 2019
address #340 (comment)
items 1, 3, placeholders for glossary entries (item 6)
@stevenchong

This comment has been minimized.

Copy link
Contributor

@stevenchong stevenchong commented Aug 8, 2019

More semantic primer to do's:

  • Example 4, line 239: add text for annotations annotation example (@mobb )
  • fix the adam.shepherd example and replace it with a real person from Cedar Creek (line 270 and also to Examples 1, 4, 5 and the second RDF graph) (@stevenchong )
  • look into putting URIs into the id attributes or use them with <annotations references ="">. (@mpsaloha ) Also need to edit the primer text and related examples. This is related to #143
@mbjones

This comment has been minimized.

Copy link
Contributor Author

@mbjones mbjones commented Aug 18, 2019

Updated release notes.

@mbjones

This comment has been minimized.

Copy link
Contributor Author

@mbjones mbjones commented Sep 4, 2019

Removed the validation service links from the docs. Much easier to run the validation class locally.

@mbjones

This comment has been minimized.

Copy link
Contributor Author

@mbjones mbjones commented Sep 4, 2019

Deprecated the eml-access module in the docs, discouraging use of the access elements. See sha 24301e3.

@mbjones

This comment has been minimized.

Copy link
Contributor Author

@mbjones mbjones commented Sep 4, 2019

Updated README and contributors doc to remove language about the ecoinformatics charter, and instead just refer to maintainers for decisions. See sha 1599997.

@mbjones

This comment has been minimized.

Copy link
Contributor Author

@mbjones mbjones commented Sep 5, 2019

Added a codemeta.json file and a 'Copy Bibtex' button in sha 5f3fccd.

@mbjones mbjones closed this Sep 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.