Skip to content

#797 Other endpoints issue #960

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

Merged
merged 4 commits into from
Sep 6, 2022
Merged

#797 Other endpoints issue #960

merged 4 commits into from
Sep 6, 2022

Conversation

LeonLu2
Copy link
Collaborator

@LeonLu2 LeonLu2 commented Aug 26, 2022

Issue: Some headings in the table of contents in the Epidata Documentation are inappropriate, need changes and re-arrange the sequence of the table.

Fixes #797

Changelog:

  1. change the headings in the table, and all of the usages of the headings in their children's file
  2. re-arrange their sequence
  3. waiting for the coming version of Just the Docs, with the feature of unlimited nested relationship which is still under development

2. change the COVIDcast Epidata API category name and the usages of its name in its descendants
@LeonLu2 LeonLu2 requested a review from krivard August 26, 2022 19:34
@dshemetov
Copy link
Contributor

Hey thanks for doing this work!

I'm not sure how to compile / host this. Could you share a screenshot of the new nav order?

@LeonLu2
Copy link
Collaborator Author

LeonLu2 commented Aug 30, 2022

Sure! Here it is:
image

@dshemetov
Copy link
Contributor

Thanks @LeonLu2. So this PR mostly looks good to me. My personal preference would be to have the "COVID-19 Trends and Impact Survey" section be higher, either below "Other Endpoints" or keep it below "Main Endpoint". The reason being that, even though it's no longer being updated, I suspect that it will still generate a lot of retrospective interest from researchers. So we want to keep it with the "data sections" and above the "development" sections.

@krivard
Copy link
Contributor

krivard commented Sep 1, 2022

So we want to keep it with the "data sections" and above the "development" sections.

I agree the current placement isn't ideal, but I'm not sure the change you propose is better -- the CTIS section is about the survey itself and doesn't mention the API at all. That would suggest that API development and API endpoint documentation should be clustered together, with CTIS set apart. You can see the effect of that in Roni's comment in #797, but since we can only have three levels in the hierarchy, this is what Leon and I came up with as a next-best.

@dshemetov
Copy link
Contributor

Ah, thanks for the context! Sounds good to me then.

# Conflicts:
#	docs/api/covidcast-signals/safegraph.md
@LeonLu2
Copy link
Collaborator Author

LeonLu2 commented Sep 3, 2022

  1. merged dev into current branch, conflicts resolved. Ready to pull

Copy link
Contributor

@krivard krivard left a comment

Choose a reason for hiding this comment

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

👍

@krivard krivard merged commit b8aaab8 into dev Sep 6, 2022
@krivard krivard deleted the leonlu2/other-endpoints branch September 6, 2022 20:57
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.

Other Diseases --> Other Endpoints?
3 participants