Integration with Dev.To

[jeanmachuca]

There is a lot of pending documentation here to describe the wonderful features of QCObjects. So a blowing idea came to mi mind. Why not write all the related articles in a selected network like Dev.To and take these contribution articles automatically downloaded and processed to a centralised documentation website?

Dev.To has a simple and incredible REST API to do so, and using the link bellow, it is possible to get all the QCObjects related in Dev.To (just a few right now, I expect you can help me as well writing new articles :) ):

https://dev.to/api/articles?tag=qcobjects

The alternatives are:
1.- An automated side menu component injected in the main reference page.
2.- A complete other website with the automated documentation knowledge base.

Have a look at the MarkdownController in the file https://github.com/QuickCorp/QCObjects/blob/master/doc/js/cl.quickcorp.controller.js
to know how to implement an automated markdown component

[felipebrunetti94]

Hi, can i take this one ?

[jeanmachuca]

Hello,

First of all, thank you very much for contributing to the QCObjects open source community!

Feel free to read and follow the contributing guidelines here!

After you've read all and you are ready to contribute in this issue, please send me an email to [email protected] and we can work together on this one.

Thanks

[topcheese]

Is it safe to assume this is dead, any progress? I'm thinking of picking this framework up, so this would be an easy one to do.

[jeanmachuca]

It's definitely alive , go ahead !

Here are some examples you can follow to code a dynamic component

https://github.com/QuickCorp/QCObjects-SDK/blob/master/demo-tests/test-component-grid.html

https://github.com/QuickCorp/QCObjects-SDK/blob/master/demo-tests/test-component-list.html

Also, feel free to proceed If you also want to make an article or translation to your own language talking of this experience

[topcheese]

It will take some time, but that is a good idea. I'm still testing it out, and I think there's an issue with the SwaggerUI integration, so I was thinking of filing an issue.

I'll read over the contributor document and will report back.

[jeanmachuca]

If you like to add some new feature to the swagger ui Integracion you can add a new issue with the feature template.
Please follow this [quick tutorial: working with swagger ui as a QCObjects component] (https://devblog.qcobjects.org/working-with-swagger-ui-as-a-qcobjects-component-ck6xzoqkg05indfs1i4rxq72e) and if you find something to add to this you can write your own article based on that and add a new issue with the url. So other people can find it easier

Thank you for contributing!