Updated documentation to make it more useful #451
Conversation
Signed-off-by: Swarnim Pratap Singh <[email protected]>
a0b7ea1 to
c1ff152
Compare
|
Hi @nguyer , I've added some changes in firefly documentation. Please review it. |
|
I think @nickgaski might be working on an issue with the docs build - sorry for the delay on this one. Is that right Nick? |
|
|
||
| - Key Concepts: [Broadcast / shared data](/keyconcepts/broadcast.html) | ||
| - Swagger: [POST /api/v1/namespaces/{ns}/broadcast/message](/swagger/swagger.html#/default/postBroadcastMessage) | ||
| - Key Concepts: [Broadcast / shared data](/firefly/keyconcepts/broadcast.html) |
There was a problem hiding this comment.
This broke the link for me on a local build of the docs, using the instructions here:
https://github.com/hyperledger/firefly/blob/main/docs/contributors/docs_setup.md#build-and-serve-the-docs-locally
However, I agree the main site is broken. So I think the issue here might be the local build instructions need to have a /firefly prefix somehow so that authors can test their changes correctly.
There was a problem hiding this comment.
I've raised #461 for that issue @nickgaski - hopefully that helps you with the review on this one.
| description: "" | ||
| servers: | ||
| - url: http://localhost:12345 | ||
| - url: http://localhost:5000 |
There was a problem hiding this comment.
This file is auto-generated, so the next time someone runs make swagger this will be overwritten. There is also a check to make sure that the file that is checked in to Git matches what the code would generate, and this is the check that's currently failing, blocking this from merging.
I think we can change this port to 5000, but it would just need to be changed in the swagger generator code, rather than in the auto-generated file.
There was a problem hiding this comment.
I think the make swagger command actually just runs some specific unit tests. I suspect that these instances would need to change in order to update the port:
internal/apiserver/swagger_check_test.go: handler := as.apiWrapper(as.swaggerHandler(as.swaggerGenerator(routes, "http://localhost:12345")))
internal/apiserver/swagger_generate_test.go: handler := as.apiWrapper(as.swaggerHandler(as.swaggerGenerator(routes, "http://localhost:12345")))
|
@TheSwarnim - would be great to get your improvements into the mainline. |
I've added some changes in firefly documentation which I think will make it more useful and informative.