SeattleTestbed / docs

Documentation for Seattle Testbed (scroll down for README)
MIT License
40 stars 164 forks source link

Convert files to use Markdown formatting #4

Closed aaaaalbert closed 8 years ago

aaaaalbert commented 8 years ago

The documentation files should be updated to use Markdown. This involves renaming them to use the .md file extension, but also converting the previoous Trac wiki markup.

However, see also #2 --- don't go and blindly convert things. Start with RepyV1/2 docs+tutorial, clearinghouse, custom installer builder docs. Then proceed to the other things.

Any help is appreciated! Just add your GiHub handle and the page you will be converting as a comment below.

You can use the tractomd.py-script for some limited automatic conversion!

lukpueh commented 8 years ago

start with RepyV1/2 docs+tutorial

aaaaalbert commented 8 years ago

FYI, #8 converted the RepyV2 tutorial and API docs.

aaaaalbert commented 8 years ago

12 converted the RepyV1 tutorial and API docs.

lukpueh commented 8 years ago

Some converted pages may still point to old trac wiki pages that have not been converted yet. So it is a good idea to check from time to time and update the links if the pages have been updated, e.g. like so when in the docs directory:

grep -lr --include="*.md" "wiki:\|\.wiki" .
aaaaalbert commented 8 years ago

Excellent point, we need to check this regularly.

aaaaalbert commented 8 years ago

Note: Clearinghouse and Custom Installer Builder docs conversions / updates per #13, #14.

aaaaalbert commented 8 years ago

9ce5e758ac94191bf3372806710756b93d097787 converts the "formal installer documentation" and infrastructure architecture document.

aaaaalbert commented 8 years ago

8595301d114e69aafb031c7deb125b5c7d41320f converts the Unit Test Framework docs.

aaaaalbert commented 8 years ago

18 converts BaseInstallers, Clearinghouse/Design, CIB API and Usage, Operating/SWUP, and Zenodotus.

aaaaalbert commented 8 years ago

@ankitbhatia32 is going for EducationalAssignments and Programming.

ankitbhatia32 commented 8 years ago

I have converted almost all the folder and files except the ATTACHMENTS. Here is the link: https://github.com/ankitbhatia32/docs

aaaaalbert commented 8 years ago

No .wiki files are left in this repo, so I'm closing this issue. Thank you for your contributions!