networknt / light-doc Goto Github PK

The section in hero.html is commented out already and it needs to be enabled once the logo is done.

I am thinking the logo should be a lighting in a cloud.

On navigating to https://doc.networknt.com/tutorial/common/ the links are provide as Unit test, Integration test, Consumer driven contract test, End-to-end test.

If you click on Unit Test, then it actually navigates you to the last of the four items.

I believe the expectation is that the next/previous links would take you through the links in the order listed. Not sure how to fix in Hugo.

Installation on Linux and Turn off certificate verification

Tracking broken links:

Main header:

• Blog: https://doc.networknt.com/blog/ ☑️

Home page:

• Check out light-4j middleware handlers. : http://docs.networknt.com/ ☑️
• Use the right framework for the right product. : https://www.networknt.com/templates/ ☑️
• OAuth2, Portal and other infrastructure services. : https://www.networknt.com/templates/ ☑️
• Tool chain for code generation, devops and CI/CD. : https://www.networknt.com/templates/ ☑️

Docs:

Left menu:

• Milestones: https://www.networknt.com/milestone/ ☑️
• About:
  • Features: https://www.networknt.com/about/features/ ☑️
• Contribute:
  • Development: https://www.networknt.com/contribute/development/ ☑️
• Troubleshooting:
  • Mostly empty page. ☑️

Doc's Pages:

https://www.networknt.com/contribute/

• "Read more" link under "Contribute to Hugo Development" ☑️
• "Tutorial" -> blank. ☑️
• "Example" -> blank. ☑️

https://www.networknt.com/consumer/

• Customized Grant -> blank. 🔲
• Token Startup -> blank. 🔲
• Long Lived Token -> blank. 🔲
• Traceability -> blank. 🔲
• Traceability Id -> blank. 🔲
• Correlation Id -> blank. 🔲
• Service Discovery -> blank. 🔲
• Registry -> blank. 🔲
• Standalone Registry -> blank. 🔲
• Docker Registry -> blank. 🔲
• Kubernetes Registry -> blank. 🔲
• Discovery -> blank. 🔲
• Consul Discovery -> blank. 🔲
• Zookeeper Discovery -> blank. 🔲
• Load Balance -> blank. 🔲
• Round Robin -> blank. 🔲
• Local First -> blank. 🔲
• Consistent Hash -> blank. 🔲
• Light Router -> blank. 🔲
• Router Use Case -> blank. 🔲
• Router Location -> blank. 🔲

https://www.networknt.com/tool/

• "Light Codegen" -> https://www.networknt.com/consumer/service-discovery/ 🔲
• "Why Another Generator" -> https://www.networknt.com/consumer/registry/ 🔲
• "OpenAPI Parser" -> https://www.networknt.com/consumer/load-balance/ 🔲
• "Why This Parser" -> https://www.networknt.com/consumer/round-robin/ 🔲
• "Swagger Bundler" -> https://www.networknt.com/consumer/light-router/ 🔲
• "Why Build It" -> https://www.networknt.com/consumer/router-use-case/ 🔲

https://www.networknt.com/tool/openapi-converter/

• "openapi-parser" -> blank ☑️
• "light-codegen response from example." -> https://www.networknt.com/tutorial/generator/openapi-mock/ (Yes. Correct.) ☑️

to enable customization and replacement for services.

As most of our examples are using service.yml to create a singleton DataSource, we have clear text password in the config. For financial institutions, it is not allowed. We need to write a tutorial on how to encrypt the db password in secret.yml and also how to initialize two or more DataSource objects.

@NicholasAzar I am wondering if you could write a tutorial for the GraphQL subscription. It is a very important feature and a lot of people are interested in it. I have created a md file in master branch at

https://github.com/networknt/light-doc/blob/master/content/tutorial/graphql/subscription.md

Give a landing page for each framework, infrastructure service, and tool once users visit the getting started.

https://github.com/networknt/light-doc/blob/develop/content/tool/light-codegen/openapi-generator.md

light-codegen: OpenAPIGenerator has already been updated

Additions to be added in:
https://doc.networknt.com/development/best-practices/

To cover best practices on:
exception handling, performance, dependency injection, etc.

Add a link to the light-rest-4j pom.xml for the latest dependencies and versions. Review the rest of the document and put an index on the home page.

Update the mask module document to indicate how to use JsonPathStartupHookProvider to switch the JsonPath JSON parser to Jackson.

In https://doc.networknt.com/tutorial/oauth/longlive/ , there is a paragraph:
Both private keys and public key certificates can be found in security module of light-4j. The same public key certificates are included in light-4j services so that the server can verify any token issued by this oauth server

with "security module of light-4j" is a dead link (https://github.com/networknt/light-4j/tree/master/security/src/main/resources/config/oauth). I found that there are pairs of keys exist in https://github.com/networknt/light-4j/tree/master/security/src/test/resources/config , but it belongs to test, seems not correct. Would you please update it?

Hi @stevehu,

I've been spending a bit of time reviewing the documentation generated from this repo, and it seems that there are a number of incomplete pages being hosted. It's making me question whether it's a good idea to release these pages on the main webpage as they could be confusion or frustrating for new users.

As this is the interface to the library and likely the first impression that will be made with the users. I think we could benefit by approaching documentation from more of a quality vs quantity approach and avoiding releasing specific documentation until they are thoroughly reviewed and verified.
One important aspect could be that developers who are new to the framework being part of this review as their feedback could have been taken for granted by the authors and would be a valuable perspective.

I realize that this suggestion might slow down the documentation publishing process, however it could ultimately reduce effort by minimizing the number of questions being posed by users and even help us transition between developers.

Do you think this is something worth pursuing?

In either case, i will continue to go through the existing documentation and put together a list of some items that we could look to improve or fix. Hopefully this will help!

For example, the hugo site card is

https://github.com/networknt/light-doc/blob/master/themes/gohugoioTheme/static/images/gohugoio-card.png

compare between spring boot and light-4j implementation in a spring boot instance.

Add three different scenarios with examples.

networknt/light-rest-4j#74

Document changes in light-4j:#295 for logging enhancements in the audit handler

It is based on a real project web-client which is the web-based client for taiji-blockchain.

Need to have a document to explain what these files are and how to use them in one single document. Details can be referred from this document.

(API -32) Light-consumer-4j usage document created

For every couple of weeks, we need to run hugo on the project and upload the algolia.json to the Algolia.com to replace the indexes.