Skip to content

Commit

Permalink
Merge pull request #911 from sharetribe/doc-improvements
Browse files Browse the repository at this point in the history
Documentation improvements
  • Loading branch information
Gnito committed Sep 5, 2018
2 parents e45e066 + 62cce8f commit b76a9ef
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 3 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ way to update this template, but currently, we follow a pattern:

---
## Upcoming version 2018-09-XX
* [change] Update git links and improve documentation
[#911](https://github.com/sharetribe/flex-template-web/pull/911)
* [change] improve env-template to better defaults.
[#912](https://github.com/sharetribe/flex-template-web/pull/912)
* [fix] Touch event from location autocomplete prediction list ended up causing clicks.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ If you just want to get the app running quickly to test it out, first install
[Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/), and follow along:

```sh
git clone [email protected]:sharetribe/sharetribe-starter-app.git # clone this repository
cd sharetribe-starter-app/ # change to the cloned directory
git clone [email protected]:sharetribe/flex-template-web.git # clone this repository
cd flex-template-web/ # change to the cloned directory
cp .env-template .env # copy the env template file to add your local config
emacs .env # in your favorite editor, add the mandatory env vars to the config
yarn install # install dependencies
Expand Down
2 changes: 1 addition & 1 deletion docs/customization-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ In the directory you want to create the project in:

git clone [email protected]:YOUR_USERNAME/YOUR_FORK.git # clone your fork
cd YOUR_FORK # changed to the cloned directory
git remote add upstream [email protected]:sharetribe/sharetribe-starter-app.git # add the template as the upstream remote
git remote add upstream [email protected]:sharetribe/flex-template-web.git # add the template as the upstream remote

See also the
[Configuring a remote for a fork](https://help.github.com/articles/configuring-a-remote-for-a-fork/)
Expand Down
3 changes: 3 additions & 0 deletions docs/search-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ _capacity_ attribute the parameter would be "pub_capacity".
Further reading on public data can be found in the
[extended data documentation](./extended-data.md).

**NOTE:** Please contact the Sharetribe support in order to update your listing index schema when
planning to use new listing fields as search filters.

### Common changes

A few common changes are required to add a select single or a select multiple filter to desktop and
Expand Down

0 comments on commit b76a9ef

Please sign in to comment.