Comments (13)
Original comment by Aaron Bartell (Bitbucket: aaronbartell, GitHub: aaronbartell).
Marking this as resolved. The docs are now in this repo and can subsequently be massaged by core committers and PRs.
from nodejs-idb-connector.
@ThePrez Started the process of porting the Docs from Developer works. See PR #6
from nodejs-idb-connector.
Original comment by Jesse G (Bitbucket: ThePrez, GitHub: ThePrez).
@KerimG, sorry for the unclear update. I'm just saying that this project and pconnector should follow the same conventions. I like the pconnector API doc's format and layout:
https://bitbucket.org/litmis/nodejs-idb-pconnector/src/master/docs/main.md
We'll need to do our own invention or reuse for further doc of the generated code.
No apology needed on the inactivity. It's better to be busy than bored!
from nodejs-idb-connector.
Original comment by Kerim Gueney (Bitbucket: KerimG, GitHub: KerimG).
What exactly do you mean? Do you have a concrete example or are you saying that this project and nodejs-idb-pconnector should follow the same conventions? If it's the latter, I agree. Regarding your ESDoc suggestion: you could host the generated docs on Bitbucket's static website hosting or GitLab Pages (I've always been a big fan of GitLab, even more so after Microsoft's acquisition of Github)
Sorry for being inactive in the past few months. I joined a company in the AS400 sphere at the beginning of the year and my work load increased rapidly in May. I will try to make time for the docs, though!
from nodejs-idb-connector.
Original comment by Jesse G (Bitbucket: ThePrez, GitHub: ThePrez).
@KerimG and @abmusse , I propose we follow the same conventions for the Javascript API's. Do you agree?
from nodejs-idb-connector.
Original comment by Jesse G (Bitbucket: ThePrez, GitHub: ThePrez).
@KerimG, thanks again for taking this! I am assigning this issue to you, but please coordinate with willing-to-help @abmusse to complete the documentation for this repo as well as the nodejs-idb-pconnector (I think it'd be great if we used the same conventions for both).
from nodejs-idb-connector.
Original comment by Jesse G (Bitbucket: ThePrez, GitHub: ThePrez).
Thanks, @KerimG! I've added you to the "team" for this repo. You should be able to fork the project by following the '+' icon from the upper left.
from nodejs-idb-connector.
Original comment by Kerim Gueney (Bitbucket: KerimG, GitHub: KerimG).
I got in touch with @InfernoSpirit and I'm going to do the docs. Can someone adjust the repository permissions or so, so that I can fork?
from nodejs-idb-connector.
Original comment by Kerim Gueney (Bitbucket: KerimG, GitHub: KerimG).
Saw in #2 that @InfernoSpirit has volunteered to do the documentation. Is he going to do it all? Should I contact him for coordination?
Also, I'd like to mention again that I like @ThePrez 's idea . My only question is, is ESDoc the right tool considering the source code of the idb-connector isn't in JavaScript?
from nodejs-idb-connector.
@KerimG I am also working on Documenting the newly made idb-pconnector which is a promised based version of the current idb-connector.
Check it out here : https://bitbucket.org/litmis/nodejs-idb-pconnector/overview
We can coordinate and get both idb versions Documented with examples.
from nodejs-idb-connector.
Original comment by Kerim Gueney (Bitbucket: KerimG, GitHub: KerimG).
I wouldn't mind converting the existing docs to markdown, I'll try and do it some time soon!
I also like @ThePrez 's suggestion. I mean, we could do both because an API reference is definitely necessary but I'm also sure many appreciate a more verbose documentation along with examples in the style of the current docs.
from nodejs-idb-connector.
Original comment by Jesse G (Bitbucket: ThePrez, GitHub: ThePrez).
I would propose embedding the doc in the code and using ESDoc to generate good HTML... but then the question isçwhere would it be hosted?
Here is a good example of ESDoc in action: http://reactivex.io/rxjs/class/es6/Notification.js~Notification.html
If we like this idea, I know there are several similar solutions and I am not bound to ESDoc if others have a different preference.
from nodejs-idb-connector.
Original comment by Aaron Bartell (Bitbucket: aaronbartell, GitHub: aaronbartell).
We would LOVE for somebody to take up the documentation.
At the end of the day we need it in markdown format, though we haven't yet decided where it will go (this wiki, a *.md file in this repo, readthedocs.io, etc).
Would you be willing to convert the docs on developerWorks to markdown?
from nodejs-idb-connector.
Related Issues (20)
- Error SQLSTATE=02000 SQLCODE=100 HOT 4
- Error SQLSTATE=38501 SQLCODE=-443 does not return the true message HOT 1
- idb-connector not compatible with Node.js v16.x HOT 30
- Error SQLSTATE=02000 SQLCODE=100 HOT 1
- Error SQLSTATE=22504 SQLCODE=-191 Mixed data or UTF-8 data not properly formed. HOT 22
- Use of BINARY Parameter w/Stored Procedure Call Corrupts the Node Process HOT 3
- Handling permanent JOB... HOT 1
- Some issues when calling SP with dbstmt.bindParameters() HOT 1
- Error: SQLSTATE=22504 SQLCODE=-191 Mixed data or UTF-8 data not properly formed. HOT 1
- Not receiving output from Stored Procedure and no clear example..
- temporary memory of job increases massive when using CLOB/JSON field in SQL-request HOT 3
- Connection Pool HOT 3
- Add package-lock.json? HOT 1
- the sql state error seems to be fixed, but we have a different issue HOT 4
- idb-connector *SP calls returns invalid numeric data -- Node 18, IDB-Connector 1.2.18 HOT 21
- test: cleanup test infrastructure HOT 1
- CLOB: truncation of the last char ! HOT 6
- Fix license headers on source files
- Reference idb-pconnector for promise / connection pooling support
- Build from source is failing since release 1.2.19 HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from nodejs-idb-connector.