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

Documentation needs new home #87

Closed
ThePrez opened this issue Dec 12, 2019 · 6 comments
Closed

Documentation needs new home #87

ThePrez opened this issue Dec 12, 2019 · 6 comments
Labels
keep-open Exempts stale action from auto closing the issue/pr. stale
Milestone

Comments

@ThePrez
Copy link
Member

ThePrez commented Dec 12, 2019

Current link points to https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/IBM%20i%20Technology%20Updates/page/Toolkit%20for%20i%20APIs

There is a TODO in the readme about this, but I figure it's better to track in an issue.

@abmusse
Copy link
Member

abmusse commented Dec 12, 2019

@ThePrez

One we release v1.0.0 can we simply update developer works to point to our docs folder?

@ThePrez
Copy link
Member Author

ThePrez commented Dec 12, 2019

No. The developerWorks site is going away. But we can just have the npm module point to the right spot

@ThePrez
Copy link
Member Author

ThePrez commented Dec 12, 2019

I see that is already done for v1.x, so nothing needs to be done unless v1 is still alpha when developerWorks goes away

@kadler
Copy link
Member

kadler commented Jan 13, 2020

@abmusse and I think the best solution is using mkdocs in conjunction with https://readthedocs.org.

@kadler kadler added this to the Version 1.0 milestone Feb 7, 2020
@github-actions
Copy link

github-actions bot commented Mar 9, 2020

👋 Hi! This issue has been marked stale due to inactivity. If no further activity occurs, it will automatically be closed.

@github-actions github-actions bot added the stale label Mar 9, 2020
@abmusse abmusse added the keep-open Exempts stale action from auto closing the issue/pr. label Mar 10, 2020
@abmusse
Copy link
Member

abmusse commented Mar 23, 2020

@kadler

For v1.0.0 lets maintain the docs within the repository docs folder.

We can use mkdocs in conjunction with https://readthedocs.org. at a later time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
keep-open Exempts stale action from auto closing the issue/pr. stale
Projects
None yet
Development

No branches or pull requests

3 participants