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

Remove specification files that have been moved to 'eligibility-api' project #49

Merged
merged 1 commit into from
Nov 18, 2021

Conversation

angela-tran
Copy link
Member

What this PR does

cal-itp/eligibility-api#7 copied over and made edits to the docs/specification files from this project. This PR removes those files from the eligibility-server docs.

It also updates the URLs in the README.md file (even though the API docs aren't publishing yet).

Tested locally

The Specification link is no longer present.

image

…ligibility-api' project

Update URL in README.md in anticipation of published docs, and fix typo.
@angela-tran angela-tran added this to the November 2021 milestone Nov 16, 2021
@angela-tran angela-tran self-assigned this Nov 16, 2021
the client implementation in [`benefits`](https://github.com/cal-itp/benefits).

View the technical documentation online: [https://docs.calitp.org/eligibility-server](https://docs.calitip.org/eligibility-server)
View the technical documentation online: [https://docs.calitp.org/eligibility-server](https://docs.calitp.org/eligibility-server)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great catch! ty!

@thekaveman
Copy link
Member

Note this should not be merged until the API docs are published online! (Still need a GitHub Actions workflow)

@angela-tran
Copy link
Member Author

Note this should not be merged until the API docs are published online! (Still need a GitHub Actions workflow)

Good point - I will set this as a Draft until then. Thanks!

@angela-tran angela-tran marked this pull request as draft November 16, 2021 19:58
@angela-tran angela-tran marked this pull request as ready for review November 18, 2021 00:30
@angela-tran
Copy link
Member Author

API docs are published online! (thanks to combo of cal-itp/eligibility-api#8 and cal-itp/eligibility-api#11)

Check it out at: https://docs.calitp.org/eligibility-api/

image

@machikoyasuda
Copy link
Member

@angela-tran Looks great!

@angela-tran angela-tran merged commit 2c49813 into main Nov 18, 2021
@angela-tran angela-tran deleted the refactor/move-api-docs branch November 18, 2021 01:15
@angela-tran angela-tran mentioned this pull request Nov 14, 2022
10 tasks
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

Successfully merging this pull request may close these issues.

3 participants