Skip to content

Sphinx inventory is missing for UJS #84

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

Closed
Julian opened this issue Oct 2, 2023 · 10 comments
Closed

Sphinx inventory is missing for UJS #84

Julian opened this issue Oct 2, 2023 · 10 comments
Assignees
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: In Progress This issue is being worked on, and has someone assigned. Status: Stale It's believed that this issue is no longer important to the requestor.

Comments

@Julian
Copy link
Member

Julian commented Oct 2, 2023

This link: https://json-schema.org/understanding-json-schema/objects.inv

on the old website was a Sphinx inventory for Understanding JSON Schema.

It now appears to be a 404.

I know we don't plan on sticking with Sphinx, or perhaps have already switched away from it as part of the website move and I simply didn't know the 2 were happening together -- though regardless, even if we use some other documentation tool, it would be nice to at least consider continuing to provide this file or an equivalent. Its purpose is pretty "universal" in nature -- it's meant to help automated tooling understand where links should go within the site, so other documentation systems likely still could be coerced into producing one.

(This issue essentially breaks sphinx-json-schema-spec and transitively python-jsonschema's documentation, though if it turns out we've now officially moved over to something else obviously I'll rework those projects.)

@Relequestual
Copy link
Member

We wanted to have the site and all pages managed under the same framework and tooling, and using markdown.
I had no idea we were publishing a Sphinx inventory.

Can you construct one from the markdown we have in the website repo now? A quick google tells me the answer is maybe yes. If so, I suspect you're going to need to do the legwork on this one 😅. (Or at least, I suspect there will be python involved.)

Julian added a commit to python-jsonschema/jsonschema that referenced this issue Oct 9, 2023
See json-schema-org/website#84 for minor context.

This obviously isn't/wasn't very hard in this specific repo, given we
only really link to the homepage.

Some more work may be required in sphinx-json-schema-spec.
@benjagm benjagm added ✨ Enhancement Indicates that the issue suggests an improvement or new feature. 💬 Question Further information is requested labels Nov 23, 2023
@benjagm benjagm removed the 💬 Question Further information is requested label Dec 4, 2023
@benjagm
Copy link
Collaborator

benjagm commented Dec 4, 2023

Is this feasible with the new website's stack?

@Julian
Copy link
Member Author

Julian commented Dec 4, 2023

Probably yes although I haven't given it any time looking into it yet -- probably would keep this as low priority since I'm the primary user of it is my guess :D

@benjagm benjagm added the Status: Available No one has claimed responsibility for resolving this issue. label Feb 20, 2024
@benjagm benjagm moved this from Todo to Waiting for Contributions in Website Contributor Board Feb 20, 2024
@praveen-rikhari
Copy link
Contributor

Hii @Julian do you think this is still relevant did we come up with a solution for sphinx-json-schema-spec and pythons-json-schema?? I can take this down if we want this page to come back to the new website stack

@benjagm benjagm moved this from Waiting for Contributions to In Progress in Website Contributor Board Feb 22, 2024
@Julian
Copy link
Member Author

Julian commented Feb 22, 2024

Yes I think it's still relevant!

@benjagm benjagm moved this from In Progress to Waiting for Contributions in Website Contributor Board Feb 26, 2024
@nikhilyadav24
Copy link

Hey @benjagm , Please assign this to me.

@benjagm
Copy link
Collaborator

benjagm commented Feb 28, 2024

Sure @nikhilyadav24 . Go ahead. Feel free to ask as many questions as you may need.

@benjagm benjagm added Status: In Progress This issue is being worked on, and has someone assigned. and removed Status: Available No one has claimed responsibility for resolving this issue. labels Feb 28, 2024
@benjagm benjagm moved this from Waiting for Contributions to In Progress in Website Contributor Board Feb 28, 2024
@benjagm
Copy link
Collaborator

benjagm commented Apr 11, 2024

Are you still working on this @nikhilyadav24 ?

Copy link

github-actions bot commented Jun 2, 2024

Hello! 👋

This issue has been automatically marked as stale due to inactivity 😴

It will be closed in 180 days if no further activity occurs. To keep it active, please add a comment with more details.

There can be many reasons why a specific issue has no activity. The most probable cause is a lack of time, not a lack of interest.

Let us figure out together how to push this issue forward. Connect with us through our slack channel : https://json-schema.org/slack

Thank you for your patience ❤️

@github-actions github-actions bot added the Status: Stale It's believed that this issue is no longer important to the requestor. label Jun 2, 2024
Copy link

github-actions bot commented Dec 1, 2024

This issue did not get any activity in the past 180 days and thus has been closed. Please check if the main branch has fixed it. Please, create a new issue if the issue is not fixed.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: In Progress This issue is being worked on, and has someone assigned. Status: Stale It's believed that this issue is no longer important to the requestor.
Projects
Status: In Progress
Development

No branches or pull requests

5 participants