docs/omf-release-0.1 #202

marie-x · 2020-03-03T00:39:11Z

Separate PR for documentation, so that you don't have to dig around in the catch-up PR.

This PR should be merged before the catch-up PR so that it's included.

Edits and requests for additional documentation are welcome and encouraged.

* Add MDS-Web-Sockets docs * Typo * Remove example response

twiddle README add NOT FOR CONTRIB to service-areas

sarob · 2020-03-03T17:07:50Z

Looks great so far. One likely change to discuss. Jascha would like to make the repo root readme files read mostly the same. If we can all agree to that, then the current mds-core readme.md will need to change to something like DevWorkstationSetup.md. I will push an update on this PR today for review.

replace paragraphs 2,3 as too spec related with a link to spec readme instead move mds-core development guidelines to CONTRIBUTING.md add a missing link change the order of the table items make a command decision on using mds-core instead of MDS-core

also eliminate garbage from bad markdown linter

sarob · 2020-03-07T23:59:41Z

Starting to review dev workstation setup (after moving it from the root readme) which is now part of this PR. I went back through the openstack infrastructure management and project creation guides as reference for running local and remote tests.

- readme changes similar to lacuna-tech/mds-core#202 - move configuration from readme to CONFIGURATION.md - changes in preperation for first OMF release

…in some cases, mark packages not intended for contrib.

missing one ref and it didnt read well

# Conflicts: # README.md # packages/mds-event-processor/README.md # packages/mds-geography/README.md

also a bit about experimental content

some basic reorganization so it is easier to follow steps added index ill start verifying steps next after that a pass at vm in win, vm in macos

Using a few other projects as a guide

plus a few fix ups

# Conflicts:

- shell commands and multi line outputs are bracketed as code - single line outputs are bracketed as inline code - Moved a few sections to operations - Added package descriptions - Added expected install results Some errors were logged as part of the mds-core bootstrap script. I will post these to the PR. I got all the way to the mds-core build section, where I get `curl: (52) Empty reply from server` after running 'curl localhost/agency’.

sarob · 2020-04-10T23:02:15Z

While working on DevWorkstationSetup.md, I have been following the steps. This is what I have found so far

Some errors were logged as part of the mds-core bootstrap script. I can post these to the PR or somewhere else more helpful.
I got all the way to the mds-core build section, where I get curl: (52) Empty reply from server after running 'curl localhost/agency’.
yarn.lock has a new reference for chalk 4.0.0
package.json requires the node reference be updated from 12.14.1 to 13.12.0 before I could run git commit
Should I be pushing these two files to the mds-core repo?

I needed to manually reset the node version for yarn. Once past that the install part of the script appears to exit clean. However, during the build it existed with @container-images/mds-geography-author: ../../node_modules/@mds-core/mds-types/dist/index.d.ts(2,72): error TS2306: File '/Users/sarob/code/lacuna-tech-mds-core/node_modules/@mds-core/mds-types/dist/scopes.d.ts' is not a module. I will include the updated config files this time.

sarob · 2020-04-20T01:02:50Z

I figured out the bootstrap script install. Small tweak now part of the doc. Now working through a bootstrap script build problem.

janedotx · 2020-04-23T17:46:56Z

ARCHITECTURE.md

+
+# Authentication & Identity
+We authenticate and authorize access to APIs and public-facing websites using JSON Web Tokens (JWT). JWTs are issued by Auth0 using the OAuth 2.0 protocol. 
+## Auth0


I think a sentence or two about why we chose Auth0 and the pros of cons of other authentication alternatives might be nice too (since my understanding is that while implementers need to use JWTs, they might not choose to use Auth0 to handle JWTs).

Yeah, I agree that adding some additional information about Auth0 would be great

janedotx · 2020-04-23T18:02:38Z

ARCHITECTURE.md

+The repo currently has integration tests with code-coverage minimums on a per-project basis.  [TODO add more]
+# Versioning
+The services in mds-core will follow the MDS spec’s requirements for [API versioning](https://github.com/openmobilityfoundation/mobility-data-specification/blob/dev/general-information.md).
+# Shared Libraries


This will need to be updated to add mds-service-helpers and mds-webpack-config

wesleyfsmith · 2020-04-24T17:21:42Z

ARCHITECTURE.md

+## mds-utils
+Grab-bag of shared utility methods. Including, but not limited to: Programmatic representation of the MDS-Agency State Machine, date-time converters, and geospatial analysis methods.
+## mds-web-sockets
+Implementation of a basic websocket model for MDS. Enables real-time external consumption of data through a pub/sub model. See package documentation for specific examples. 


Should we mention that it's probably a better practice to use NATS instead of hooking into the web sockets directly?

twelch · 2020-09-11T16:29:14Z

@karcass Is this PR stale and can be closed?

avatarneil · 2021-05-11T00:10:43Z

Closing due to inactivity

avatarneil and others added 2 commits February 27, 2020 15:01

[docs] Add docs for mds-web-sockets (#191)

892595a

* Add MDS-Web-Sockets docs * Typo * Remove example response

add ARCHITECTURE.md

a383814

twiddle README add NOT FOR CONTRIB to service-areas

sarob added 2 commits March 3, 2020 10:57

change readme to OMF project landing page

fafca98

readme updates

984e9c8

replace paragraphs 2,3 as too spec related with a link to spec readme instead move mds-core development guidelines to CONTRIBUTING.md add a missing link change the order of the table items make a command decision on using mds-core instead of MDS-core

sarob added the documentation Improvements or additions to documentation label Mar 6, 2020

add missing ref links to readme

4d651f0

also eliminate garbage from bad markdown linter

sarob mentioned this pull request Mar 8, 2020

change readme to OMF project landing page openmobilityfoundation/mds-compliance-mobile#9

Open

marie-x and others added 5 commits March 9, 2020 11:05

make sure we have at least rudimentary README files in each package. …

e25cdc7

…in some cases, mark packages not intended for contrib.

Merge branch 'develop' into docs/omf-release-0.1

58e3308

tiny WIP

68d3639

small adjustment to contribution page ref

32eca8f

missing one ref and it didnt read well

Merge branch 'develop' into docs/omf-release-0.1

99826fa

# Conflicts: # README.md # packages/mds-event-processor/README.md # packages/mds-geography/README.md

janedotx requested review from janedotx, avatarneil, BigIdeas, brianngca, mdurling, levi217, owenoak, twelch and whereissean March 18, 2020 19:37

marie-x and others added 6 commits March 19, 2020 10:45

placeholder

8ae7134

trimming obsolete readmes

79f661d

moar readmes

2d2dad0

Update readme with running, testing mds-core

cd7575b

also a bit about experimental content

first pass at dev workstation setup

2b23a73

some basic reorganization so it is easier to follow steps added index ill start verifying steps next after that a pass at vm in win, vm in macos

second pass at devworkstation cleanup

9e50c8e

Using a few other projects as a guide

sarob added 2 commits March 27, 2020 16:00

fix bad filename

9e10c9a

Added references to technical details

4067c4c

plus a few fix ups

marie-x added the omf-release Blocks OMF release label Mar 30, 2020

marie-x and others added 3 commits March 30, 2020 17:06

Merge branch 'develop' into docs/omf-release-0.1

953ad3e

# Conflicts:

Merge branch 'develop' into docs/omf-release-0.1

9c71905

janedotx reviewed Apr 23, 2020

View reviewed changes

wesleyfsmith approved these changes Apr 24, 2020

View reviewed changes

marie-x changed the title ~~[DRAFT] docs/omf-release-0.1~~ docs/omf-release-0.1 May 19, 2020

mdurling removed request for owenoak and mdurling September 24, 2020 23:56

twelch removed request for avatarneil, BigIdeas, brianngca, levi217, twelch and whereissean October 24, 2020 01:35

avatarneil closed this May 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs/omf-release-0.1 #202

docs/omf-release-0.1 #202

marie-x commented Mar 3, 2020

sarob commented Mar 3, 2020 •

edited

Loading

sarob commented Mar 7, 2020 •

edited

Loading

sarob commented Apr 10, 2020

sarob commented Apr 20, 2020

janedotx Apr 23, 2020 •

edited

Loading

wesleyfsmith Apr 24, 2020

janedotx Apr 23, 2020

wesleyfsmith Apr 24, 2020

twelch commented Sep 11, 2020

avatarneil commented May 11, 2021

docs/omf-release-0.1 #202

docs/omf-release-0.1 #202

Conversation

marie-x commented Mar 3, 2020

sarob commented Mar 3, 2020 • edited Loading

sarob commented Mar 7, 2020 • edited Loading

sarob commented Apr 10, 2020

sarob commented Apr 20, 2020

janedotx Apr 23, 2020 • edited Loading

Choose a reason for hiding this comment

wesleyfsmith Apr 24, 2020

Choose a reason for hiding this comment

janedotx Apr 23, 2020

Choose a reason for hiding this comment

wesleyfsmith Apr 24, 2020

Choose a reason for hiding this comment

twelch commented Sep 11, 2020

avatarneil commented May 11, 2021

sarob commented Mar 3, 2020 •

edited

Loading

sarob commented Mar 7, 2020 •

edited

Loading

janedotx Apr 23, 2020 •

edited

Loading