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

Edits / Typos / Issues in the mdBook Documentation #5

Open
dignizio-usgs opened this issue Jan 28, 2015 · 3 comments
Open

Edits / Typos / Issues in the mdBook Documentation #5

dignizio-usgs opened this issue Jan 28, 2015 · 3 comments

Comments

@dignizio-usgs
Copy link
Contributor

For now, issues will be tracked here to avoid any write conflicts.

Add a - [ ] to render a checkbox at the beginning of each suggestion.

@dignizio-usgs
Copy link
Contributor Author

  • Section 3.1.1 Viewer:
    Line 1 under 'Purpose' -- "documentation" is misspelled.

  • Section 3.1.1
    "Instead, allow the user to pick what elements are of interest, and choose the degree of detail pertaining to those elements."

    Consider updating to: "Instead, the interface allows the user to pick..."

@dignizio-usgs
Copy link
Contributor Author

  • 3.1.3 Translator
    "The mdTranslator converts an input metadata record, written to a known JSON standard, such as the ADIwg JSON standard."
    This sentence was confusing to me when I read it the first few times. I think it might be clearer if this sentence were combined with the one that follows it, like this:

"The mdTranslator can be used to convert a well-formatted input record from one compliant standard (such as the ADIwg JSON standard) to another metadata standard (such as the ISO 19115-2 standard, in XML). Currently the mdTranslator supports only the ADIwgJSON to ISO XML conversion, but additional translation capabilities may be added in the future."

@dignizio-usgs
Copy link
Contributor Author

  • 3.1.1 Viewer, 3.1.2 Validator, 3.1.3 Translator
    It might be good to eventually have pointers/URL's to these resources somewhere in this documentation to help users find them (in case they happen to be reading the documentation as a stand-alone doc somehow), as well as know specifically what is being referenced when the documentation describes something. I know the location of these may not be fixed yet... consider a placeholder?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant