https://forge-allura.apache.org/p/allura/tickets/You searched for labels:"docs"enThu, 10 Oct 2024 14:27:16 -0000https://forge-allura.apache.org/p/allura/tickets/8468/The Allura/docs/api-rest/ files are using older versions of RAML (and json schema too). We should update those so we can use more recent raml tooling like https://github.com/raml2html/raml2htmlDave BrondsemaThu, 10 Oct 2024 14:27:16 -0000https://forge-allura.apache.org/p/allura/tickets/8468/https://forge-allura.apache.org/p/allura/tickets/8009/The records in the `notification` collection do not need to stick around forever. It'd be good to have a paster command to clean up old ones, and documentation about setting up a cron job for it. Even better if we can think of a smart way to handle it automatically within allura, so a cron job wouldn't be necessary. Here's the basic query: db.notification.remove({pubdate:{$lt: new Date(Date.now() - 1000*60*60*24*31*2)}})Dave BrondsemaThu, 22 Oct 2015 19:31:36 -0000https://forge-allura.apache.org/p/allura/tickets/8009/https://forge-allura.apache.org/p/allura/tickets/7995/* fix warnings * expose mongo port * don't share python env in current dir. If you're using Mac/Windows there's no need for it to be shared to the host, since it can't be re-used there * make docs a little easier to useDave BrondsemaMon, 05 Oct 2015 14:00:10 -0000https://forge-allura.apache.org/p/allura/tickets/7995/https://forge-allura.apache.org/p/allura/tickets/7835/##### Update the documentation theme to the "mobile first" [read the docs](https://github.com/snide/sphinx_rtd_theme). * Remove `Allura/docs/_templates/layout.html`, but make sure we can still link back to Allura home. * Restructure the `toctree` to improve side bar navigation: ("Introduction", "Running Allura", etc). Reference: [1](http://django-cms.readthedocs.org), [2](http://www.graphicall.org/ftp/ideasman42/html/introduction/) Heith SeewaldThu, 20 Aug 2015 22:06:09 -0000https://forge-allura.apache.org/p/allura/tickets/7835/https://forge-allura.apache.org/p/allura/tickets/7829/With [#4542] we should have docs of how webhooks work (payload examples, secret validation, etc). Can be at https://sourceforge.net/p/forge/documentation/Allura%20API/ or a page in this project's wiki.Dave BrondsemaThu, 20 Aug 2015 22:06:09 -0000https://forge-allura.apache.org/p/allura/tickets/7829/https://forge-allura.apache.org/p/allura/tickets/7252/Write more docs about Activity Streams, both the library and how it works with Allura. Think high-level and make sure we cover a view of the whole system. Perhaps make a guide section in here http://allura.sourceforge.net/docs/#developing-alluraDave BrondsemaFri, 07 Mar 2014 19:22:16 -0000https://forge-allura.apache.org/p/allura/tickets/7252/https://forge-allura.apache.org/p/allura/tickets/7173/Dave BrondsemaThu, 20 Aug 2015 22:07:00 -0000https://forge-allura.apache.org/p/allura/tickets/7173/https://forge-allura.apache.org/p/allura/tickets/6896/It'd be useful to have some high-level docs for developers that are getting started with Allura. And update/overhaul our current developer-oriented doc pages. I think we should cover things like: how the code is organized, what technology is used (paster, TG, EW, jinja, etc), how to log & debug, how tests work, etc.Dave BrondsemaThu, 20 Aug 2015 22:07:10 -0000https://forge-allura.apache.org/p/allura/tickets/6896/https://forge-allura.apache.org/p/allura/tickets/6424/https://sourceforge.net/p/forge/documentation/Allura%20API/ should gain some docs on the discussion API added in [#5650] For bonus points, move/convert these docs into Allura itself, and change that wiki page to explain how SourceForge runs on Allura and reference the allura docs.Dave BrondsemaThu, 20 Aug 2015 22:07:54 -0000https://forge-allura.apache.org/p/allura/tickets/6424/https://forge-allura.apache.org/p/allura/tickets/6373/We should document how to run paster commands, 'paster script ...' for some common scripts (note the difference between the 2 scripts dirs), and how some can be run as tasks at /nf/admin/task_manager/new, and other /nf/admin abilities. Dave BrondsemaMon, 10 Aug 2015 15:21:57 -0000https://forge-allura.apache.org/p/allura/tickets/6373/https://forge-allura.apache.org/p/allura/tickets/5943/After README, there are a lot of things to do to really get started, which aren't explained: * what neighborhoods are * how to get to a nbhd admin page and configure stuff * remove default users: `db.user.update({username:/test/}, {$set: {disabled:true}}, false, true);db.user.update({username:/root/}, {$set: {disabled:true}}, false, true);db.user.update({username:/admin/}, {$set: {disabled:true}}, false, true);` * remove adobe nbhd: `db.neighborhood.remove({url_prefix:'/adobe/'})` * remove test project: `db.project.remove({shortname:'test'}) // may need to add a neighborhood_id` parameter if the project name exists in more than one nbhd. * change `[handler_console]` in the ini file to use `allura.lib.utils.CustomWatchedFileHandler` so that it goes to a file and gets task info included * change `beaker.session.secret` and `beaker.session.validate_key` in the `.ini` file to new values (first used for simple cookies, latter used for encrypted cookies) Several of these are explained in default wiki content now. docs/installation.rst has some post-setup content which should be freshened, and enhanced to include more.Dave BrondsemaMon, 10 Aug 2015 15:21:56 -0000https://forge-allura.apache.org/p/allura/tickets/5943/https://forge-allura.apache.org/p/allura/tickets/5886/*Originally created by:* algorithms We have narrative documentation placeholder for creating custom Allura tools. Use the headlines in the narrative to walk through the process of actually creating an Allura tool and update the documentation to reflect the process. http://allura.sourceforge.net/tutorials/wiki-tool.htmlAnonymousThu, 20 Aug 2015 22:07:52 -0000https://forge-allura.apache.org/p/allura/tickets/5886/https://forge-allura.apache.org/p/allura/tickets/5424/For someone deploying Allura, they are left on their own to provide the git, hg, or svn services. We have some docs at http://allura.sourceforge.net/docs/scm_host.html about deploying ldap & fuse controls to SCM dirs, but nothing about running the scm services Gitlab (an OSS "competitor" to Allura) includes Gitolite setup in their docs https://github.com/gitlabhq/gitlabhq/blob/stable/doc/install/installation.mdDave BrondsemaThu, 20 Aug 2015 22:07:10 -0000https://forge-allura.apache.org/p/allura/tickets/5424/https://forge-allura.apache.org/p/allura/tickets/4846/If you try to search Tracker with this queries: status:open and status:closed -> 4384 tickets WRONG status:open AND status:closed -> 0 OK Help for solr syntax uses as an example: !status:closed and summary:foo* and _milestone:1.0 but it should be: !status:closed AND summary:foo* AND _milestone:1.0Alvaro del CastilloThu, 20 Aug 2015 22:07:55 -0000https://forge-allura.apache.org/p/allura/tickets/4846/https://forge-allura.apache.org/p/allura/tickets/2313/*Originally created by:* tesch Working through getting Allura setup for the first time, just some minor tweaks to README.markdown : - 'curl' package is needed by git commit hooks, could be added to the apt-get line - the instructions could be more clear about the default location of the scm repository: from the install instructions it looks like they should be /git,/hg,/svn, but the default development.ini puts them in /tmp/... (ps, big ups to you all.) AnonymousWed, 08 Apr 2015 22:55:12 -0000https://forge-allura.apache.org/p/allura/tickets/2313/https://forge-allura.apache.org/p/allura/tickets/1650/Discussed on Jabber whether we want to allow anonymous (key-less) access to REST API, or whether we should require a key for any request. Dave confirmed that anon access is ok. Our backend actually supports it: https://sourceforge.net/rest/p/allura/home/ But REST API client we provide (both in-tree rest_api and dependency-free class used in some scripts) insist to be fed with key and secret, so that should be made optional. Paul SokolovskyMon, 01 Dec 2014 02:14:04 -0000https://forge-allura.apache.org/p/allura/tickets/1650/https://forge-allura.apache.org/p/allura/tickets/1596/https://sourceforge.net/p/forge/documentation/API%20-%20Beta/ David Burley the RW api docs should get updated to show how to do it using the raw HTTP requests that way folks can readily convert it to $language for those not python centric 11:57 Dave Brondsema good point, their is a lot of python there i'm not too familiar with oauth, i'm not sure how well examples work with raw HTTP, or if you really would always use a library 11:58 David Burley I'd probably link to that from a more general page to provide a specific python example Also, it'd be great if we could have this documentation both in the sf.net docs and the Allura docs. Maybe a brief entry for sf.net and linking over to Allura which has all the details?Dave BrondsemaThu, 20 Aug 2015 22:07:55 -0000https://forge-allura.apache.org/p/allura/tickets/1596/