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

Review and edit services.md #149

Merged
merged 3 commits into from
Oct 25, 2023
Merged

Review and edit services.md #149

merged 3 commits into from
Oct 25, 2023

Conversation

zacdezgeo
Copy link
Contributor

What I changed

Takes a crack at #148. @vincentsarago can you provide some feedback on if it matches your expectations? I'm not sure if you wanted to remove the custom mentions for each service below. They still seem relevant. I'm also unsure on how much detail we want to provide; the API documentation of each service seems to be the best-detailed view, while services.md is meant as an overview.

Edit mentions of custom functionality and detail services to match README.md.

How I tested it

  • Run mkdocs serve
  • Visit the live site and read through content

Edit mentions of custom functionality and detail services to match README.md
@zacdezgeo zacdezgeo added the documentation Improvements or additions to documentation label Oct 24, 2023
@zacdezgeo zacdezgeo self-assigned this Oct 24, 2023
@vincentsarago
Copy link
Member

I'm not sure if you wanted to remove the custom mentions for each service below. They still seem relevant. I'm also unsure on how much detail we want to provide; the API documentation of each service seems to be the best-detailed view, while services.md is meant as an overview.

Yeah I think we should remove any mention to the the custom runtime and focus on the goal of each service (mention that they are build on stac-fastapi/titiler-pgstac ... ) and what user can expect from the service

Ideally we would have 4 components:

  • Database (Postgres with PgSTAC) to host the STAC Catalog and Public vector datasets
  • Metadata Service (stac-fastapi)
  • Raster (titiler-pgstac)
  • Features/Vector (tipg)

@vincentsarago vincentsarago mentioned this pull request Oct 25, 2023
* refactor docs

* Review PR and fix a few typos

---------

Co-authored-by: Zachary Deziel <zachary.deziel@gmail.com>
@vincentsarago vincentsarago merged commit adcb499 into main Oct 25, 2023
2 checks passed
@vincentsarago vincentsarago deleted the docs/edit-services branch October 25, 2023 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants