diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 5375e9663b..a387576477 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -104,6 +104,7 @@ * [Welcome to the hackathon!](hackathon-and-events/installathon-may-2019/welcome-to-the-hackathon.md) * [Write/Speak/Code 2019](hackathon-and-events/write-speak-code-2019.md) * [Open Design: Bangalore](hackathon-and-events/open-design-bangalore.md) +* [Open Design: Taipei](hackathon-and-events/open-design-taipei.md) ## Enhancement Proposals diff --git a/docs/development-and-code/add-code-to-ushahidi.md b/docs/development-and-code/add-code-to-ushahidi.md index f619d98e05..dcb5863c7a 100644 --- a/docs/development-and-code/add-code-to-ushahidi.md +++ b/docs/development-and-code/add-code-to-ushahidi.md @@ -67,7 +67,7 @@ Where “some-task” is a short description _without spaces_ of what this task ### 7. Write Code -Now write your code. Make sure you meet the [Ushahidi coding standards](https://ushahidi.gitbook.io/platform-developer-documentation/development-process/coding-standards) and use the [Ushahidi pattern library](https://ushahidi.gitbook.io/platform-developer-documentation/changing-ui-styles-introduction-to-the-pattern-library) if you need to change the css. +Now write your code. Make sure you meet the [Ushahidi coding standards](https://ushahidi.gitbook.io/platform-developer-documentation/development-process/coding-standards) and use the [Ushahidi pattern library](setup_alternatives/setting-up-the-pattern-library-for-development.md) if you need to change the css. If you get stuck, or want to talk through ideas, you can contact [other Ushahidi developers](../get-in-touch.md). diff --git a/docs/development-and-code/setup_alternatives/installing-for-production-environments.md b/docs/development-and-code/setup_alternatives/installing-for-production-environments.md index a6bcd0b2e4..d972035eda 100644 --- a/docs/development-and-code/setup_alternatives/installing-for-production-environments.md +++ b/docs/development-and-code/setup_alternatives/installing-for-production-environments.md @@ -77,8 +77,7 @@ This steps need to be executed in the directory where the platform codebase was Create a new file named .ENV -{% tabs %} -{% tab title=".ENV" %} +{% code title=".ENV" %} ```php ## Laravel APP_ENV=production @@ -109,8 +108,7 @@ REDIS_PORT=6379 # Redis port # Enabling or disabling the maintenance mode page MAINTENANCE_MODE=0 ``` -{% endtab %} -{% endtabs %} +{% endcode %} #### Install the platform API dependencies @@ -154,8 +152,7 @@ crontab -u www-data -e Add the following lines to the crontab -{% tabs %} -{% tab title="crontab" %} +{% code title="crontab" %} ```bash MAILTO=admin@example.com #ensure a valid email for system notifications @@ -165,8 +162,7 @@ MAILTO=admin@example.com */5 * * * * cd /var/www/platform && php artisan notification:queue */5 * * * * cd /var/www/platform && php artisan webhook:send ``` -{% endtab %} -{% endtabs %} +{% endcode %} At this point, the backend is almost ready, but we still need to configure the web server and set up the client before we can see the application running. @@ -186,8 +182,7 @@ After you finished the set up, you should have a /var/www/platform-client/server Create the `/etc/nginx/sites-available/platform.conf file`, referencing the httpdocs directory in the platform-api. Example settings below: -{% tabs %} -{% tab title="/etc/nginx/sites-available/platform.conf" %} +{% code title="/etc/nginx/sites-available/platform.conf" %} ```text server { @@ -216,13 +211,11 @@ server { } ``` -{% endtab %} -{% endtabs %} +{% endcode %} Create the `/etc/nginx/sites-available/platform-client.conf` file, referencing the server/www directory in the platform-client. -{% tabs %} -{% tab title="/etc/nginx/sites-available/platform-client.conf" %} +{% code title="/etc/nginx/sites-available/platform-client.conf" %} ```text server { @@ -263,8 +256,7 @@ server { ### END OF OLD MOBILE APP SUPPORT ### } ``` -{% endtab %} -{% endtabs %} +{% endcode %} Run the following commands @@ -282,8 +274,7 @@ systemctl restart php7.1-fpm.service; Example contents for the file `/etc/php/7.1/fpm/pool.d/www.conf` -{% tabs %} -{% tab title="/etc/php/7.1/fpm/pool.d/www.conf" %} +{% code title="/etc/php/7.1/fpm/pool.d/www.conf" %} ```text [www] @@ -299,8 +290,7 @@ pm.min_spare_servers = 1 pm.max_spare_servers = 4 pm.process_idle_timeout = 30s ``` -{% endtab %} -{% endtabs %} +{% endcode %} ### Verifying the API is running diff --git a/docs/development-and-code/setup_alternatives/setting-up-the-platform-client.md b/docs/development-and-code/setup_alternatives/setting-up-the-platform-client.md index f09e40ce6c..d585293bcf 100644 --- a/docs/development-and-code/setup_alternatives/setting-up-the-platform-client.md +++ b/docs/development-and-code/setup_alternatives/setting-up-the-platform-client.md @@ -102,13 +102,11 @@ As such, the minimal working `.env` file consists of just this variable. * In your `.env` file write the `BACKEND_URL` variable, corresponding to your Platform API URL address. This is an example, showing the format used, \(**don't** just copy & paste it to your file!\): -{% tabs %} -{% tab title=".env" %} +{% code title=".env" %} ```bash BACKEND_URL=http://dont.copy.this.name.com ``` -{% endtab %} -{% endtabs %} +{% endcode %} {% hint style="info" %} If you have used one of our guides for setting up the API locally, check back the relevant section in that guide. Here are some direct links that should take you back there. @@ -167,13 +165,11 @@ npm install -g gulp * Alternatively, on Linux and Mac, you may edit the `.bashrc` file in your home directory, and append the following line: -{% tabs %} -{% tab title=".bashrc" %} +{% code title=".bashrc" %} ```bash export PATH=$HOME/bin:/usr/local/bin:node_modules/.bin:$PATH ``` -{% endtab %} -{% endtabs %} +{% endcode %} ### Running a local development server diff --git a/docs/development-and-code/setup_alternatives/xampp.md b/docs/development-and-code/setup_alternatives/xampp.md index bdf7cc244f..2d4029e7a2 100644 --- a/docs/development-and-code/setup_alternatives/xampp.md +++ b/docs/development-and-code/setup_alternatives/xampp.md @@ -206,8 +206,7 @@ In your platform folder, inside the folder `httpdocs`, edit the file `.htaccess` * File path: **platform/httpdocs/.htaccess** -{% tabs %} -{% tab title="platform/httpdocs/.htaccess" %} +{% code title="platform/httpdocs/.htaccess" %} ```text # Turn on URL rewriting RewriteEngine On @@ -230,8 +229,7 @@ RewriteCond %{REQUEST_FILENAME} !-d # Rewrite all other URLs to index.php/URL RewriteRule .* index.php/$0 [PT] ``` -{% endtab %} -{% endtabs %} +{% endcode %} #### Configure the platform/.htaccess file @@ -243,8 +241,7 @@ In your platform folder, edit the file `.htaccess`\(as before, you can open the * path: **platform/.htaccess** -{% tabs %} -{% tab title="platform/.htaccess" %} +{% code title="platform/.htaccess" %} ```text # Turn on URL rewriting RewriteEngine On @@ -259,8 +256,7 @@ RewriteEngine On # Rewrite all URLs to httpdocs RewriteRule .* httpdocs/$0 [PT] ``` -{% endtab %} -{% endtabs %} +{% endcode %} Last, but not least, we are going to configure the web server to find your platform folder and link it to the "api.ushahidi.test" server name. diff --git a/docs/frequently-asked-questions.md b/docs/frequently-asked-questions.md index 3b34abd509..04c8656c88 100644 --- a/docs/frequently-asked-questions.md +++ b/docs/frequently-asked-questions.md @@ -107,8 +107,7 @@ If the incoming task worked, check if new posts are available. If they are, then Open your crontab \(with `crontab -e`\) and check that it looks like this \(the path to platform may be different, it should point to your platform API installation directory\): -{% tabs %} -{% tab title="crontab" %} +{% code title="crontab" %} ```bash MAILTO=admin@example.com #ensure a valid email for system notifications @@ -119,8 +118,7 @@ MAILTO=admin@example.com */5 * * * * cd /var/www/platform && php artisan webhook:send ``` -{% endtab %} -{% endtabs %} +{% endcode %} If after ensuring the crontab is correct and datasources run you don't see any new posts, please get in touch through[ the Ushahidi gitter](http://gitter.im/ushahidi/Community) channel with all the details about what you tried and what you have seen, and we'll be happy to help diff --git a/docs/hackathon-and-events/open-design-taipei.md b/docs/hackathon-and-events/open-design-taipei.md new file mode 100644 index 0000000000..c165124891 --- /dev/null +++ b/docs/hackathon-and-events/open-design-taipei.md @@ -0,0 +1,37 @@ +--- +description: Ushahidi's open design workshop in Taipei at Open UP global summit 2019 +--- + +# Open Design: Taipei + +See on the Open Design website here: [https://opendesign.ushahidi.com/taipei-openup-global-summit-2019/](https://opendesign.ushahidi.com/taipei-openup-global-summit-2019/) + +The Open Design team has been accepted and invited to the excellent [Open UP Global Summit](https://www.openup.global/) in Taipei, Taiwan November 30th to December 01st 2019 to deliver a workshop. + +Open UP summit is the first interdisciplinary conference focused on open source projects and products in Asia-Pacific, aiming to provide you a unique conference experience by integrating global resources and developing open source products with a guided and enjoyable process. + +Open Design Team will be running a talk and demo of Open Design and then running a split workshop across two days on **Getting started with contributing design to OSS with TenFour, the crisis communication tool from Ushahidi**. + +[Open Design](https://opendesign.ushahidi.com/design-should-be-open-for-all/) is a project-based approach to including Design in the creation of Open Source Software that makes a meaningful impact in the world. It is led by led by Ushahidi, in partnership with Designit and Adobe. + +The workshop will be focused on [TenFour issues](https://github.com/ushahidi/tenfour/issues) relating to Cyclone & Typhoon preparation and response. + +* [Issue 171](https://github.com/ushahidi/tenfour/issues/171): Join a team/organization via opt-in method. +* [Issue 145](https://github.com/ushahidi/tenfour/issues/145): User can set a rule that a check-in is automatically sent if third party crises data set indicates an emergency. +* [Issue 106](https://github.com/ushahidi/tenfour/issues/106): SOS Request for Urgent Help. +* [Issue 66](https://github.com/ushahidi/tenfour/issues/66): User Status Update / Request Help / Manual Check-ins / Help Button. +* [Issue 131](https://github.com/ushahidi/tenfour/issues/131): Check-in urgency – When replying to a check-in. +* [Issue 112](https://github.com/ushahidi/tenfour/issues/112): Check-ins should have “severity” levels. + +In keeping to the Open Design [methodology](https://opendesign.ushahidi.com/methodology/), the workshop will also include [witnesses](https://opendesign.ushahidi.com/methodology/): people that have direct experience of the humanitarian challenge \(in this case the Typhoons, Cyclones and the resulting effect on the people and country\). Before the event, participants will receive a packet providing links to the TenFour/OSS sticker sheet, activities like Empathy maps, storyboards, Inspiration boards, and other relevant information. + +The workshop is targeted at Designers and UXers at all levels, including researchers, visual designers, UI designers, graphics designers, Interaction designers, product managers, coordinators and more. + +Are you interested in participating in the workshop? + +Get tickets here: [https://www.eventbrite.com/e/open-up-summit-2019-tickets-66847441497](https://www.eventbrite.com/e/open-up-summit-2019-tickets-66847441497) + +Follow Open Design on Twitter: [https://twitter.com/opendesignis](https://twitter.com/opendesignis) + +Follow open Design on Facebook: [https://www.facebook.com/OpenDesignIs](https://www.facebook.com/OpenDesignIs) +