IBM / xmlservice

XML-based interface for accessing IBM i resources
https://xmlservice.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
35 stars 18 forks source link

Migrate documentation from Yips Wiki to docs #19

Open kadler opened 5 years ago

kadler commented 5 years ago

The raw wiki content was migrated under b18c3140953690661d07c998e5ea83187bf4d94d and the text version under 140f1ce54e80744099408c0a6b7db0add868d7dd. The docs there need to be converted to understandable documentation and converted to restructured text under the docs directory.

NOTE: Each text file contains the URL to the page it was retrieved from to make it easy to look at the rendered HTML, as it's sometimes useful to see the documentation visually.

The basic structure I have in mind is this:

jimoibm commented 5 years ago

@kadler I will take this. Looks like we need to convert wiki format to html format first and then use Github pagers in the Settings.. 'master branch docs folder'?

Reminders:

  1. add new ctlg flag intro for *ESCP
  2. remove plugconf(x) related info? (need thoughts from @kadler )
bjeromeHCS commented 5 years ago

@jimoibm @kadler Any updates on documentation for installation? I'd like to be able to get testing going again but I don't have access to the lib installed that contained the *escp fix.

jimoibm commented 5 years ago

@bjeromeHCS there is an issue #32 that may impact the ouput and we are working on that. Did you install xmlservice with PTFs and cannot could not access the installed QXMLSERV or you meant could not access the source in GitHub?

bjeromeHCS commented 5 years ago

@jimoibm We installed it from the instructions included with the latest xmlservice.savf from the Yips page, but that's outdated. I'm not sure how to install another way with the source code in this repo.

jimoibm commented 5 years ago

@bjeromeHCS We discussed about this and will need to have a ccsid issue fixed. Then let you know how to build up xmlservice in Github.

kadler commented 5 years ago

@bjeromeHCS I have updated the README.md with build instructions. There may still be issues with the special character escaping as @jimoibm mentioned.

https://github.com/IBM/xmlservice#building-from-source

bjeromeHCS commented 5 years ago

@kadler Thank you! I will check it out when I can :)

bjeromeHCS commented 5 years ago

Just wanted to update that it seems the Makefile build worked :+1:

jimoibm commented 5 years ago

@kadler Do you know if there is a tool to convert the Yips wiki to reStructuredText? It seems Yips wiki is the format of PmWiki. I didn't find a tool that could do the conversion. Guess we have to convert by ourselves?

kadler commented 5 years ago

@jimoibm I did some searching on various tools and could not get one to convert it so I think we need to hand-convert it. Besides, I think a lot of it needs to be re-worded and re-organized anyway.

jimoibm commented 5 years ago

@kadler OK. I will try to start with converting each page to RST first. Then work with you on the re-wording and re-organizing.