From 276010fcdaeb23a492380be7e2fe74a2233a88cf Mon Sep 17 00:00:00 2001 From: Dominic Watson Date: Fri, 5 Jun 2015 09:27:06 +0100 Subject: [PATCH] Updates to the README * We no longer have a single build, we also have Dash * Pointing people at the 'about' section of the docs, rather than regurgitating everything in the README * Less specifics around contribution callout [skip ci] --- README.md | 39 +++++++++++---------------------------- 1 file changed, 11 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index d502a6f1d..9bcb15142 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ This repository contains the source and build scripts for creating Lucee's documentation. The website output of the docs can be found at [http://docs.lucee.org](http://docs.lucee.org). -Issues can be reported and tracked at [https://luceeserver.atlassian.net/projects/LD](https://luceeserver.atlassian.net/projects/LD) +Issues can be reported and tracked at [https://luceeserver.atlassian.net/projects/LD](https://luceeserver.atlassian.net/projects/LD). + +Find out more about the project at: [http://docs.lucee.org/docs.html](http://docs.lucee.org/docs.html). ## Build locally @@ -14,13 +16,13 @@ The only dependency required is [CommandBox](http://www.ortussolutions.com/produ ### Building the static documentation output -The purpose of the structure of the documentation is to allow a human readable and editable form of documentation that can be built into multiple output formats. At present, there is a single "HTML" builder, found at `./builders/html` that will build the documentation website. The source of the documentation can be found in the `./docs` folder. +The purpose of the structure of the documentation is to allow a human readable and editable form of documentation that can be built into multiple output formats. At present, we have an "HTML" builder and a "Dash docs" builder, found at `./builders/html` and `./builders/dash` that will build the documentation website and dash docset respectively. The source of the documentation can be found in the `./docs` folder. -To run the build and produce a static HTML version of the documentation website, execute the `build.sh` file found in the root of the project, i.e. +To run the build, execute the `build.sh` file found in the root of the project, i.e. documentation>./build.sh -Once this has finished, you should find a `./builds/html` directory with the website content. +Once this has finished, you should find `./builds/html` and `./builds/dash` directories with the website content / dash docsets built. ### Running a server locally @@ -32,35 +34,16 @@ This will spin up a server using CommandBox on port 4040 and open it in your bro > Note: there is currently no batch file equivalent for Windows. If you are running on windows, it should be fairly trivial to copy and adapt what is found in the `.sh` file (please let us know if you get this working). -## Pitch in - -There is a lot of work to do. The issues list can be found and expanded upon here: [https://luceeserver.atlassian.net/projects/LD](https://luceeserver.atlassian.net/projects/LD) - -### Formatting of the website - -The source code for building the HTML website can be found at `./builders/html/`. The build process will call `./builders/html/Builder.cfc$build()` and hopefully you should be able to follow the logic from there (and/or figure out what you want to edit based on the folder and file structure). - -All the css, js and imagery for the website can be found in `./builders/html/assets`. - -### Better and more accurate tag and function descriptions - -The content of the tag and function reference could do with improving. For a full guide on how to edit these reference pages, see: [http://docs.lucee.org/docs/content/docsreference.html](http://docs.lucee.org/docs/content/docsreference.html). - -### Documentation articles - -This is perhaps the hardest part of all. For the documentation to really work, we require articles and guides that go further than simply reference material of functions and tags. Guides might go under the name of things like 'Lucee Components (CFCs)' or "Using Lucee's built in PDF functionality". These pages can be cross referenced in the reference material to provide rich documentation. - -#### What is needed +## Contributing -1. A structure -2. The content +There is a lot of work to do and we appreciate contribution in all forms. The issues list can be found and expanded upon here: [https://luceeserver.atlassian.net/projects/LD](https://luceeserver.atlassian.net/projects/LD) -All input is welcome here. +More information on how the documentation is built and formatted can be found at [http://docs.lucee.org/docs.html](http://docs.lucee.org/docs.html). -## Raise issues and suggestions +### Raise issues and suggestions Issues and suggestions are always welcome (though pull requests are preferred!). Please use the issue tracker: [https://luceeserver.atlassian.net/projects/LD](https://luceeserver.atlassian.net/projects/LD). -## License +### License The project is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-nc-sa/3.0/). \ No newline at end of file