summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual
Commit message (Collapse)AuthorAgeFilesLines
...
* toaster-manual: Updated bad links and added two sectionsScott Rifenbark2018-05-241-3/+57
| | | | | | | | | | | | | | | The links to the DATABASES, SECRET_KEY, and STATIC_ROOT were bad. They were pointing to old dated software. I updated the links. Also, added a couple new sections. One is how to start a Toaster environment without its web server. The other is how to start a Toaster environment without a build server. (From yocto-docs rev: afe2708014600c0a86c649f6533dd1f6317fe742) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added ENTITY variable to track a release date and yearScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 65a87312f541e2f2b01fa1918f7a12da607fe7ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Fixed note formatting in "Useful Commands"Scott Rifenbark2018-05-241-20/+21
| | | | | | | (From yocto-docs rev: 61e26883ed2c3cb82e7853297222d5b1499788f8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Fixed capitalization on "Build Directory" term.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: a02905ae2ad015d43d5c9b88f9b68e603734bcf4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Fixed some links.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 57c261c94de9ac567321fbe8d80a1d793857d355) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Fixed a couple links.Scott Rifenbark2018-05-241-5/+5
| | | | | | | (From yocto-docs rev: fe26835dc9448738be49d08f3e96a464599897e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Terminology fix for "OpenEmbedded Layer Index"Scott Rifenbark2018-05-243-3/+3
| | | | | | | | | | | Found several instances of this being referred to as the "OpenEmbedded Metadata Index". Changed to "OpenEmbedded Layer Index". (From yocto-docs rev: 60fb601be324a350cd4d51b199915e6b72e2f9b0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated everything for new overview-manualScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | | | | | | | This involved changing the root manual folder from "getting-started" to "overview-manual". Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was changed to "YOCTO_DOCS_OM_URL". Most manuals had several occurrences of these links. The makefile needed updating to process the new manual and not process the old "getting-started" manual. (From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changed getting-started manual titlesScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | Throughout the documentation, the manual "Getting Started With Yocto Project" was used. The manual now is called "Yocto Project Overview and Concepts Manual". (From yocto-docs rev: f47d10029487420cbeb292f680084b63be0ec7e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed "Getting Started" manual linksScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | | | | There was inconsistent use when referencing the getting-started manual. The manual's name does not include the word "Manual". So, I cleaned this up across the manual set and also in the mega-manual.sed file, which was incorrectly processing the links to that manual that do not target a specific section. (From yocto-docs rev: 0f5321416f7ec50cb6c96cccb7c87ef191a25367) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Purged the YP Quick Start references from YP setScott Rifenbark2018-05-241-4/+3
| | | | | | | | | | | | | | | The original Yocto Project Quick Start is being retired for the YP 2.5 release (sumo). I have purged all the various references from the YP manual set and replaced them with references to the appropriate doc. The references were mainly into the YP dev-manual for setting up the host or for building an image. There were a few references into the new "Yocto Project Quick Build" document for overviewing manual-type references. (From yocto-docs rev: 11c0ab693962f16f87f1e21f33dd5c6ca6a6f895) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Updated Manual NotesScott Rifenbark2018-05-241-13/+25
| | | | | | | | | | | | | I did some re-wording to account for when the user does a web search for a manual and the search returns an ancient version of the manual. Many times the user is oblivious of this fact and is trying to use a version of the docs that don't come close to matching the version of the YP. (From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Removed deprecated tool sectionsScott Rifenbark2018-03-251-5/+5
| | | | | | | | | | | | | | | I took out the sections at the end of the manual that talked about the yocto-kernel tool. This tool is no longer maintained and there is no equivalent tool. I also fixed the yocto-bsp tool to be the bitbake-layers tool. This involved some consolidation of sections. I fixed some links in the kernel-dev and toaster-manual. (From yocto-docs rev: 20cda99b301b6327d816c4a4cfb3511ad25c987c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Set up for "sumo" (YP 2.5) Release.Scott Rifenbark2017-11-121-0/+5
| | | | | | | | | | | poky.ent - updated variables <manual>.xml - updated manual revision tables mega-manual.sed - replaced "2.4" with "2.5" for links. (From yocto-docs rev: 15d1f805ad11fba145155dcec17b7ec8a21ad487) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated title page notes and author groupScott Rifenbark2017-10-301-17/+19
| | | | | | | | | | | | | Made the title page notes consistent across the manual set. Made the author group information consistent as well. It is better that authorship is seen as a third party and not tied to Intel Corporation. (From yocto-docs rev: 32cec087e384e1d92e3e84bbae5c6560a0af3136) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Fixed external linksScott Rifenbark2017-10-304-4/+4
| | | | | | | | | | Found four links going to the dev-manual that should have benn going to the ref-manual. These were for YP terms. Fixed them. (From yocto-docs rev: 0c75eda3a772d8c40e381e44e563a5b79b3d0cb5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated "Defining the Default Distro and Other Values"Kristi Rifenbark2017-10-301-7/+6
| | | | | | | | | Updated with review fixes. (From yocto-docs rev: 0436ae269a02579903adae659577e944761139f5) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated the "Remote Toaster Monitoring" sectionKristi Rifenbark2017-10-161-7/+7
| | | | | | | | | Updated with review fixes. (From yocto-docs rev: de6e7e194a414826c9b1bcc19a4975c67f90ee4f) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated the "Configuring Toaster" sectionKristi Rifenbark2017-10-161-4/+12
| | | | | | | | | Updated with review edits. (From yocto-docs rev: 43dc539fb195e6194117dbc4de4d053fff53e9ff) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated "Remote Toaster Monitoring" chapterKristi Rifenbark2017-10-161-2/+6
| | | | | | | | | Review fixes. (From yocto-docs rev: 8f01b79dd217af94af1794c339027a00ff1f64c2) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Created "Configuring Toaster" chapterKristi Rifenbark2017-10-162-273/+181
| | | | | | | | | | Deleted the existing JSON chapter, and replaced it with this new chapter. (From yocto-docs rev: 86f9fb9c567310ecd1b06944c4c9107ec30df29c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Removed section "What Makes up a Release"Kristi Rifenbark2017-10-161-140/+0
| | | | | | | | | | The content was obsolete. The new information is covered in the new chapter "Configuring Toaster". (From yocto-docs rev: 680273cb8fecea84297c3102c0b19fff5bcd9d88) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated "Remote Toaster Monitoring" sectionKristi Rifenbark2017-10-161-5/+5
| | | | | | | | | Updated with review fixes. (From yocto-docs rev: 424e9cad5f950b068e6f977355c5dbdb17da52a2) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added new chapter "Remote Toaster Monitoring"Kristi Rifenbark2017-10-161-0/+164
| | | | | | | | | | Documented new direct JSON API with four subsections to let you remotely monitor Toaster. (From yocto-docs rev: 8b18ccffbcfe896f878dd912ea39b14557426b2c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated "Install Toaster Packages" sectionKristi Rifenbark2017-10-161-1/+1
| | | | | | | (From yocto-docs rev: ad679fbcd86c06e784d0ba722030b73a4698e64c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated "Use the Fixture Feature" sectionKristi Rifenbark2017-10-161-1/+1
| | | | | | | | | Updated section based on review notes. (From yocto-docs rev: 843fb2c1344a50eb7481cfc6632fa1118a3b542f) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Removed toaster-command-loadconf sectionKristi Rifenbark2017-10-161-24/+2
| | | | | | | | | There is no longer a "loadconf" command (From yocto-docs rev: 25c4385833c636bf4cff889ff6325b2a14f5fc14) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added "Use the Fixture Feature" sectionKristi Rifenbark2017-10-161-158/+27
| | | | | | | | | | | Removed two outdated sections, "Use the toasterconf.json File" and "Edit the Configuration File" and replaced them with "Use the Fixture Feature" section. (From yocto-docs rev: 8a247836a958449836effac3600f6923c5289bb6) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Rewrite of the 'Pre-Configured Releases' sectionKristi Rifenbark2017-10-161-13/+6
| | | | | | | (From yocto-docs rev: 4036a69be34613f71cca4a1f879998409f7a0665) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Rewrite of the 'Setting Up External Access' sectionKristi Rifenbark2017-10-161-7/+20
| | | | | | | (From yocto-docs rev: f3737aaeabf5ae169d07b72ef6b70e2b5d7cb4b7) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documenation: Updated "Usually October" to "October 2017" stringScott Rifenbark2017-10-061-1/+1
| | | | | | | | | | The string in the manual revision table needed updated across the set except for the kernel-dev manual. (From yocto-docs rev: e087a707e02ff913baba2ac8bc6594206f53f70c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed links for "build-directory" term.Scott Rifenbark2017-06-222-3/+3
| | | | | | | | | | | | | Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual broke several links to the id "build-directory". I fixed these to reference into the ref-manual now. (From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Created YP 2.4 "latest" docsScott Rifenbark2017-06-041-0/+5
| | | | | | | | | | | | | | Updated poky.ent to use 2.4 variables and numbering Updated mega-manual.sed to use "2.4" string for links Updated all manual revision tables to use "2.4" and "Usually October, 2017" string. (From yocto-docs rev: 17ec7da6ab3fd450c2010812f7ad689288b12dcc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added support for "pyro" name and May release date.Scott Rifenbark2017-03-241-1/+1
| | | | | | | | | | | | | poky.ent - changed the "tbd" and "TBD" strings to "pyro" and "Pyro", respectively. Manual Head Files - Updated the manual history table with the May release month. (From yocto-docs rev: 076226d2986d0cf69685121e4342f50c1603fc7b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated "latest manual" note on title pageScott Rifenbark2017-02-191-6/+26
| | | | | | | | | | | | | | | Fixes [YOCTO #10076] The note on the title page for each manual was brief regarding where to find the latest version of the manual. I updated the note to have more detailed information on finding current, alternate, and latest versions of the manual based on YP releases. (From yocto-docs rev: 0ec81465296a7a78309d3039af4d00caa52d2285) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to support developing 2.3 YP docsScott Rifenbark2016-11-161-0/+5
| | | | | | | | | | | | | | | | | | Changes to the following: * All manual revision tables to indicate a 2.3 release proposed for April of 2017. * Updated the poky.ent file so that all variables needed reflect 2.3 values. * Updated the mega-manual.sed file so that processing of links in the mega-manual work for a 2.3 release. (From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added video link to 2.2 Toaster Intro.Scott Rifenbark2016-10-131-0/+7
| | | | | | | (From yocto-docs rev: 5f93674dbb26db55302471b65f2bc2fa2d78ab8b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated Manual revision table for 2.2Scott Rifenbark2016-10-111-1/+1
| | | | | | | | | Added string "October 2016" as the release date. (From yocto-docs rev: db40986677746afbbb138d9cbe3885111550b7c5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Changed the Webport address:Scott Rifenbark2016-07-191-2/+2
| | | | | | | | | | Using 0.0.0.0:8400 as a better way to set up this address. Easier on the user. (From yocto-docs rev: bef463d2743989596388fda7e97119f43da045a8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: splitted long lineEd Bartosh2016-07-191-1/+2
| | | | | | | | | | | The TOASTER_DIR=... checksettings line is too long and got truncated when documenation in pdf format is made. Splitting it to two lines should fix this. (From yocto-docs rev: f3bf1c7b4094a9fda60f7f9d99363a947afed261) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: point keywords to Django documentationEd Bartosh2016-07-191-3/+7
| | | | | | | | | | Pointed SECRET_KEY, STATIC_ROOT and DATABASE keywords to the Django documentation. (From yocto-docs rev: d4a6291ad6ef40963c601e60dd861c76499d8b3f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Update toaster start documentationMichael Wood2016-07-191-6/+22
| | | | | | | | | | | | - Update starting toaster to source toaster start - Add webport address documentation - Remove redundant "syncdb" call - Make it clearer that collectstatic uses STATIC_ROOT (From yocto-docs rev: 75516923f72b8d1f52cfd62281f71b637c9cac93) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add OpenSUSE to the list of distrosEd Bartosh2016-07-191-1/+1
| | | | | | | | | | | Updated instructions of restarting apache. As OpenSUSE way of restarting apache is the same as Ubuntu and Debian it's enough to just add OpenSUSE to the list of distros. (From yocto-docs rev: 0aed02ca72303574d17996dc56484f76c772c864) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: update runbuilds instructionsEd Bartosh2016-07-191-11/+42
| | | | | | | | | | | | Added sample configuration files and instructions for the runbuilds systemd service. Service runs runbuilds in a screen session for user convenience. User can attach to the session to see the runbuilds output, monitor logs and build environment. (From yocto-docs rev: 40beaa575fb96a06992a1d62bb45cd0cbbe2ae86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: update apache configuration fileEd Bartosh2016-07-191-5/+15
| | | | | | | | | | | | | | | | Changed access control instructions to work with Apache 2.4 according to https://httpd.apache.org/docs/current/upgrading.html. Added 'Require all granted' for wsgi.py according to https://docs.djangoproject.com/en/1.9/howto/deployment/wsgi/modwsgi/. Changed python module path for WSGIDaemonProcess as python version changed and modules are installed to the different path. (From yocto-docs rev: 503b6c3c250936e889ce146bfcd301ed55e638d2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add instructions for OpenSUSEEd Bartosh2016-07-191-0/+4
| | | | | | | | | | Added description of the location of apache configuration file for OpenSUSE Leap 42.1 (From yocto-docs rev: 50f9a376072ce0b7d3ed4650ca3c3ea8e5ff14dc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: change mysql driverEd Bartosh2016-07-191-2/+1
| | | | | | | | | | | | | Here is a quote from Django 1.9 documentation regarding this: mysqlclient is a fork of MySQLdb which notably supports Python 3 and can be used as a drop-in replacement for MySQLdb. At the time of this writing, this is the recommended choice for using MySQL with Django. (From yocto-docs rev: deb02aeea4912f9d7978de3529467e4503eeeffb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add instructions to create userEd Bartosh2016-07-191-2/+1
| | | | | | | | | | Creating separate toaster account would make production setup more isolated and maintainable. (From yocto-docs rev: 50ed20ad881da8d454a520903dadff20c5011fae) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add list of packages for openSUSEEd Bartosh2016-07-191-0/+7
| | | | | | | | | Added package installation instructions for openSUSE Leap 42.1 (From yocto-docs rev: 895fd65a8641c877ef6eba49e20d34fd71dd7d66) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: update list of packagesEd Bartosh2016-07-191-2/+2
| | | | | | | | | | | Changed mod_wsgi package names as Toaster requires python 3 version of mod_wsgi. Added missing python3-pip, mariadb-server, mariadb-devel and python3-devel to the list of packages for Fedora. (From yocto-docs rev: 8a2da9855c0ed5dd137808fa976cbe707048551e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>