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

Migrate documentation from Yips Wiki to docs #19

Open
8 tasks
kadler opened this issue Jan 23, 2019 · 11 comments
Open
8 tasks

Migrate documentation from Yips Wiki to docs #19

kadler opened this issue Jan 23, 2019 · 11 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@kadler
Copy link
Member

kadler commented Jan 23, 2019

The raw wiki content was migrated under b18c314 and the text version under 140f1ce. 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:

  • An intro page with the basics
  • A page to document the list of actions/tags available with links to each action's documentation
  • A page/section for each action's documentation
  • A page describing all the ways you can call XMLSERVICE: CGI, database stored procedures, etc
  • A page describing the control options and what they do
  • A page describing what IPC is and why to use it (should be noted that it's quite advanced topic)
  • A page on error handling (hah!)
  • A page on pitfalls (numerous)
@kadler kadler added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jan 23, 2019
@jimoibm
Copy link
Contributor

jimoibm commented Apr 4, 2019

@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
Copy link

@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
Copy link
Contributor

jimoibm commented Apr 16, 2019

@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
Copy link

@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
Copy link
Contributor

jimoibm commented Apr 19, 2019

@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
Copy link
Member Author

kadler commented Apr 23, 2019

@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
Copy link

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

@bjeromeHCS
Copy link

Just wanted to update that it seems the Makefile build worked 👍

@jimoibm
Copy link
Contributor

jimoibm commented May 8, 2019

@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
Copy link
Member Author

kadler commented May 8, 2019

@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
Copy link
Contributor

jimoibm commented May 9, 2019

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants