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

Document JSON-RPC api #717

Closed
ann0see opened this issue Mar 4, 2022 · 8 comments · Fixed by #909
Closed

Document JSON-RPC api #717

ann0see opened this issue Mar 4, 2022 · 8 comments · Fixed by #909
Assignees

Comments

@ann0see
Copy link
Member

ann0see commented Mar 4, 2022

As soon as jamulussoftware/jamulus#1975 is merged, we need to link the JSON-RPC.md file somewhere from the website.

Where should the link be? Server admin? User manual? Tips and Tricks?

@pljones
Copy link
Contributor

pljones commented Mar 5, 2022

I'd say we need

  • what it is, how to use it, which links to
  • what the protocol looks like

as separate pages - as the protocol could change whilst "what it is and how to use it" should be more or less static.

Then the "what it is and how to use it" would be linked from the client and server pages where it should get a simple mention.

@ann0see
Copy link
Member Author

ann0see commented Mar 5, 2022

The link to the actual documentation should be JSON-RPC.md in the main repo under the docs/ folder

@gilgongo
Copy link
Member

  • what it is, how to use it, which links to
  • what the protocol looks like

Do we have texts for these already in jamulussoftware/jamulus#1975? I seem to recall we did, but where/are there two PRs?

@gilgongo
Copy link
Member

gilgongo commented Mar 14, 2022

BTW I'm not qualified to write anything on this so I won't do it. But structure-wise, I agree we should just plonk in a brief "what it is, how to use it" into Software-Manual and Running-a-Server (I'd add a section after Command Line Options) and then put the hard docs into the repo .md.

@ann0see
Copy link
Member Author

ann0see commented Mar 15, 2022

Just added a link on the cli page. Client and server admin manual should also have it mentioned.

@pljones
Copy link
Contributor

pljones commented Jun 18, 2022

Moving to 3.9.1 -- the API isn't finalised as of 3.9.0 so documentation isn't pressing.

@ann0see
Copy link
Member Author

ann0see commented Jul 8, 2022

Also there are things which need to be updated in the app: jamulussoftware/jamulus#2704 (comment)

@pljones
Copy link
Contributor

pljones commented Aug 29, 2022

Bumping to 3.10.0. There are a few more bits that need doing for JSON-RPC.

@pljones pljones modified the milestones: Release 3.9.1, Release 3.10.0 Aug 29, 2022
ann0see added a commit to ann0see/jamuluswebsite that referenced this issue Mar 26, 2023
@ann0see ann0see mentioned this issue Mar 26, 2023
3 tasks
ann0see added a commit to ann0see/jamuluswebsite that referenced this issue Mar 26, 2023
ann0see added a commit to ann0see/jamuluswebsite that referenced this issue Mar 26, 2023
@ann0see ann0see closed this as completed Apr 9, 2023
@pljones pljones added this to Tracking Jul 28, 2023
@github-project-automation github-project-automation bot moved this to Triage in Tracking Jul 28, 2023
@pljones pljones moved this from Triage to Done in Tracking Jul 28, 2023
This was linked to pull requests Jul 29, 2023
@pljones pljones removed a link to a pull request Jul 29, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants