e. OpenACS documentation, website, and community

Request notifications

  1. What's the best way to find information on OpenACS?
  2. I'd like to make a change to the documentation. How do I do that?

  1. Q: What's the best way to find information on OpenACS?

    A: Getting started with the OpenACS community

  2. Q: I'd like to make a change to the documentation. How do I do that?

    A:

    1. Create a bug in the bug-tracker that says what the problem is and how it should be fixed. Suggest wording if possible.

    2. If you really want to help, you can actually make the changes yourself, as a patch. Here's how to make a patch:

      1. For documentation: Locate the relevant file that the documentation is generated from. It will be located in packages/acs-core-doc/www/xml/ probably then under install-guide The file should be an .xml file. (If you're changing API documentation, it will not be an .xml file, but instead it will be in the tcl directory for the given package).
      2. If your OpenACS code is not in CVS: make a copy of the file you'd like to edit. For example: cp upgrade.xml upgrade-original.xml
      3. Edit the documentation as you see fit. You can read about how documentation is done in OpenACS if you like. But simple changes won't require any background reading.
      4. If your OpenACS code is in CVS:

        cvs diff -u > patch-file

      5. If your OpenACS code is not in CVS: compare the original and the changed file

        diff -u upgrade-original.xml upgrade.xml > patch-file

    3. Attach your patch to the bug you created.
    When you create a patch, we will often apply it within a couple of days. Otherwise, we get to it as soon as we can.

    Please note that the documentation is updated only when a developer regenerates it. That is done fairly frequently, but it can take a few days for the changes to go live to the website.

Add comment