search

microbiomedata / nmdc-schema

National Microbiome Data Collaborative (NMDC) unified data model
https://microbiomedata.github.io/nmdc-schema/
Creative Commons Zero v1.0 Universal
26 stars 8 forks source link

Developer documentation and `Dockerfile` contradict one another #1739

Closed eecavanna closed 3 months ago

eecavanna commented 5 months ago

The developer documentation says that spinning up the Docker Compose stack will result in a Mkdocs dev-server listening for incoming requests; but that is no longer the case as of commit https://github.com/microbiomedata/nmdc-schema/commit/3a1381bd050c8a538fc29edc759b90acb4050929, in which the command that starts the Mkdocs dev-server was commented out.

https://github.com/microbiomedata/nmdc-schema/blob/3db6cff34450bfca7d48e305c1495af36606730f/Dockerfile#L67-L71

eecavanna commented 5 months ago

Here's the path forward I want to take:

eecavanna commented 5 months ago

The command poetry install is commented out also. That means the Python dependencies will not be installed in containers when they are instantiated from the built container image.

ssarrafan commented 5 months ago

@eecavanna will move to next sprint for decision. Do you think we should add a column to the sprint board for "decisions needed"?

eecavanna commented 4 months ago

Hi @ssarrafan, there's a tag I have liked on other projects, called awaiting-response (whether in pursuit of making a decision, gathering more information, etc.).

I think I'd prefer not having a column on the sprint board for "decisions needed". That's because it can occur at various stages of todo -> in progress -> in review -> done and I like the left-to-right flow that the current set of columns "encourages."

eecavanna commented 4 months ago

I don't expect us to get to this this sprint anymore, so I'll move it to the next one.

turbomam commented 4 months ago

Sorry for leaving things in the bad state @eecavanna . I can help get the documentation to agree with the current implementation, or work together with you to go back to your previous implementation, as long as it works on MacOS and Linux.

eecavanna commented 4 months ago

It's OK @turbomam. Moving to next sprint as I will be out of the office tomorrow (sprint ends tomorrow).

eecavanna commented 3 months ago

@turbomam and I discussed this today. I will remove him as an assignee and open a PR that updates the documentation.

eecavanna commented 3 months ago

I opened a PR that resolves this issue. Link to PR: https://github.com/microbiomedata/nmdc-schema/pull/1854