Skip to content

Convert files to use Markdown formatting #4

Closed

Description

@aaaaalbert

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!

Activity

  1. self-assigned this
    on May 6, 2016
  2. lukpueh commented on May 6, 2016

    @lukpueh
    Contributor

    start with RepyV1/2 docs+tutorial

  3. aaaaalbert commented on May 10, 2016

    @aaaaalbert
    ContributorAuthor

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

  4. aaaaalbert commented on May 11, 2016

    @aaaaalbert
    ContributorAuthor

    #12 converted the RepyV1 tutorial and API docs.

  5. lukpueh commented on May 17, 2016

    @lukpueh
    Contributor

    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" .
  6. aaaaalbert commented on May 18, 2016

    @aaaaalbert
    ContributorAuthor

    Excellent point, we need to check this regularly.

  7. added a commit that references this issue on May 20, 2016
  8. aaaaalbert commented on May 20, 2016

    @aaaaalbert
    ContributorAuthor

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

  9. aaaaalbert commented on Jun 23, 2016

    @aaaaalbert
    ContributorAuthor

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

  10. aaaaalbert commented on Jul 15, 2016

    @aaaaalbert
    ContributorAuthor

    8595301 converts the Unit Test Framework docs.

  11. aaaaalbert commented on Jul 20, 2016

    @aaaaalbert
    ContributorAuthor

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

  12. aaaaalbert commented on Oct 10, 2016

    @aaaaalbert
    ContributorAuthor

    @ankitbhatia32 is going for EducationalAssignments and Programming.

  13. ankitbhatia32 commented on Oct 10, 2016

    @ankitbhatia32
    Contributor

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

  14. aaaaalbert commented on Nov 29, 2016

    @aaaaalbert
    ContributorAuthor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions