srtab / alexandriadocs Goto Github PK

When archive submitted through API is empty, cause an unexpected exception: ReadError: empty file.

Implement search by title and submitted static content:

• Install and configure django-haystack with elasticsearch engine;
• Create model ImportedFile to hold file's info of static content submitted to be indexed by django-haystack;
• Define search index class for ImportedFile model and extract content from html file using PyQuery;
• Add search by project, indexing the title, description and author;
• Write/rewrite tests.

Improve SEO over all alexandriadocs project. Need to install and configure https://django-meta.readthedocs.io app.

• Run django migrations;
• Run django collectstatic.

Create script to be injected on each static site index.html file. The script must create a top header menu to help users return to alexandria site.

Add support to grouping projects creating a class that handle the groups options.

Finish IntegrityTarValidator on projects/validators to check tar integrity.

Add support to search projects by tag, suggesting principal tags used.

When users access project docs, they can't return to AlexandriaDocs without using browser history or can be confused where they are. Adding a back button to project docs can solve this problem.
The best way to do that is to inject a script into each docs file. The script will add a topbar to help localize the users and to users get back to AlexandriaDocs.

Prepare first release v0.1.0:

• Add setup.py to project;
• Add bumper to project;
• Improve README.md;
• Fill CHANGELOD.md file.

Private projects will need to be served directly by Django and that's not good. There's some strategies to avoid Django from serving directly, leaving the job to Nginx.
The first step is to create a middleware to catch sub-domains hosts and redefine urlconf of request to be specially served by an endpoint specially created for this cases. This endpoint will do the rest using and django app django-sendilfe.

Refs:

• https://wellfire.co/learn/nginx-django-x-accel-redirects/;
• https://github.com/johnsensible/django-sendfile.

All docs search results are linking to index.html page.

• Create django project alexandria-docs;
• Configure unit tests with tox;
• Configure Dockerfile;
• Configure Travis;

Add support to python 3 and adapt tests to run on python 2.7 and 3.

• Add template for search page;
• Search by projects and pages;
• Add pagination.

Ability to configure an Google Analytics ID to be included on project documentation.

http://shields.io/#your-badge

Add page template to:

• integrate bower;
• list all projects submitted with pagination;
• search bar

Add to project an automatically generated screenshot of static site rendered. See python-webkit2png

When user upload a package, either through form in the project manage or API, application must validate if is a valid one checking sended files.
The package must:

• contain an index.html as root element of package;
• index.html is a valid html file.