Giter Club home page Giter Club logo

ofn-userguide's Introduction

Welcome to the OFN User Guide

Language version Link to the user guide
You are reading the English version!
Accéder à la version française du guide utilisateur Open Food Network
Accediu a la versió catalana de la guia d'usuari de Open Food Network
Open Food Network Kullanım Kılavuzunun Türkçe versiyonu için burayı ziyaret edin
Visite aqui para a versão em português do Guia do Usuário da Open Food Network
Руководство пользователя Russian Open Food Network находится здесь.
Acceder a la versión en español de la Guía de Usuarias de Open Food Network
Lesen Sie hier die deutsche Version des OFN Benutzerhandbuchs
Accedi alla versione in italiano della Guida agli utenti di Open Food Network

This user guide is designed to help you get the most out of the Open Food Network platform to support the operation of local food enterprises and short food chains wherever you live.

An overview

The Open Food Network enables local people to build better, fairer ways to source their food locally and directly from growers, farmers and producers. Expansive networks of small food producers, distributors, retailers, food hubs, food co-ops and buying groups can come together with the aid of the Open Food Network to find the best way of shortening the food supply chain. And in the process it helps to build strong communities.

The Open Food Network is a global project that supports the operational organisation of farmers, groups of consumers, cooperatives, etc. in the distribution of local food. The software we build is open source, and we collaborate with amazing people from all over the world to keep improving it! We also provide support in the organisational aspects of setting up and running a food hub. Please get in touch with your local OFN contact to learn more about us!

This short video will give you a brief introduction to how the Open Food Network works, and what we can do for your food business, or organisation.

{% embed url="http://www.youtube.com/embed/eA3IcMUnU14" %}

What's in our user guide?

> Quick setup guides tailored to your enterprise

Are you new to the Open Food Network? Take a look at our quick start guides for step-by-step instructions on setting up your enterprise for the first time.

{% hint style="info" %} Find out more about where your enterprise fits in the Open Food Network here {% endhint %}

> Features to meet your needs

Already set up, but want to find out more? Find a detailed explanation of every feature our platform offers so you can tailor your Open Food Network enterprise to meet your individual needs.

{% hint style="info" %} We recommend these guides to users who would like to customise their Open Food Network enterprise specifically to meet the needs of their business or customers. {% endhint %}

{% hint style="success" %} They are also a great resource for answering any questions you may have. {% endhint %}

> Guidelines on complementary software you might like to use in combination with the Open Food Network

The Open Food Network does a lot of things, but no one tool can fit all needs. We have listed some needs for which you might need complementary software, and how you can set them up to work hand in hand with your local Open Food Network platform.

> Trouble shooting

Still not finding what you need? Check the Trouble Shooting section to see if your question has been asked by other users

> Search

Looking for information on something specific? Use the search bar in the top right corner to find the information you need.

Feedback

Any problems with our user guide? Is there any information missing? Or maybe you want to share some features you would like to see in the future? Get in touch with your local OFN entity, we'd love to hear your feedback.

ofn-userguide's People

Contributors

amidaofn avatar bethanofn avatar cecilia-hn avatar come-maiz avatar dacook avatar drummer83 avatar emilyjeanrogers avatar filipefurtad0 avatar geowill avatar gitbook-bot avatar gracejam avatar ireneficos avatar jensheridan avatar jesschen0 avatar jveilleux avatar karlafalk avatar kirstenalarsen avatar lbwright22 avatar lin-d-hop avatar macanudo527 avatar mcmpp avatar myriamboure avatar rachl avatar renatacumming avatar sauloperez avatar sigmundpetersen avatar simoneluijckx avatar sstead avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

ofn-userguide's Issues

Add how to: Process deposits for returnable packaging

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English

Description
As discussed in Slack and in this wishlist item there are already ways to process deposits for returnable packaging in the OFN. They are not ideal but worth mentioning in the user guide as a 'how to'.

Which section would you like the new content to be added to?

  • Quick Start Guide
  • Features
  • Hub Management Tips (How to's)
  • Troubleshooting
  • Glossary
  • other- please state:

In which instance(s) do you know that users are adversely affected by this information being missing from the User Guide in its current form?
Australia, France, Germany, (USA)

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

I would like to be part of a larger User Guide group who write this section

  • yes
  • no
  • as a checker

Changes to note on product price being inclusive of tax

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Current text in the user guide has a Note following the section Add Products - Price that is not reflective of how tax is applied in all instances. Current text reads:

If your enterprise is registered for tax or you select that this product carries tax, then the price you put here is inclusive of Tax. If you select that this product is tax free, the price you enter will be the tax free price.

In Canada and the USA (possibly other instances) the product price should be exclusive of tax as taxes are applied at checkout on taxable products.

We submitted the following text to change the note:

If the product is taxable then the price you put here should be inclusive of Tax (UK/EU enterprises) OR exclusive of Tax (USA and Canada enterprises) [How taxes are applied depend on the tax rules for the country where you are operating, if you are unsure when to include taxes contact your local instance].

If you select that this product is tax free, the price you enter will be the tax free price.

Other instances may want to add their country name to let users know whether the product price in their country should be inclusive or exclusive of tax.

Also note, we removed the text 'If your enterprise is registered for tax or you select that this product carries tax' as this is a separate issue and should be addressed elsewhere. Whether tax is applied requires both the product to be 'taxable' and the 'enterprise registered for tax'. In this section all the user needs to know that if the product IS taxable then whether or not the product price should be inclusive or exclusive of tax.

Which language version of the User Guide are you viewing?
English

Description
Brief description of what is wrong in the current version of the User Guide.

What is the nature of the error?

  • Information (text) inaccurate
  • Screen shot inaccurate/out of date
  • Broken hyperlink
  • Spelling mistake
  • Other

URL of the page/section on which you have found inaccurate information
Please provide a link to the page/section (subsection if possible) in the user guide on which you have found the error.

https://guide.openfoodnetwork.org/basic-features/products-1/products

Submitted change to wording: https://app.gitbook.com/o/-L9rgjXCVdbnhSow2XnR/s/-L9rgk4wEweX_zxXIzmW-887967055/~/changes/379/basic-features/products-1/products/~/comments/Gn9SuZnIlKtjshsCwSJB

Screen shot of the error or copy and paste the incorrect text in here

Additional Context
Add any extra information here. If this affects your instance but not all instances which speak the same language as you, then adding in some context about how important the issue is for you is really helpful.

Remove 'embed shopfront' references from user guide

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Description
The 'embed shopfront' feature mentioned in the user guide is no longer supported. All references to this feature will therefore need to be removed so as not to confuse users

What is the nature of the error?

  • Information (text) inaccurate
  • Screen shot inaccurate/out of date
  • Broken hyperlink
  • Spelling mistake
  • Other

URL of the page/section on which you have found inaccurate information

The English version of the Groups section of the user guide contained a subsection on embedding groups. This has been removed in the English version, but still needs to be removed from the Spanish version for example.
The digital markets page mentions embedding, so this also needs to be updated.

Additional Context
In the UK we had an enquiry from a user interested in this feature (as he'd found it in the user guide), which reflected poorly on OFN when we informed him the feature was no longer supported.

Update links to other languages

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Which language version of the User Guide are you viewing?
all

Description
The list of available languages is growing and so the first page with links to those should be kept up to date.

URL of the page/section which you would like improved/updated
https://guide.openfoodnetwork.org/

In which instance(s) do you know that users are adversely affected by this section of the User Guide in its current form?
Global

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

How could the current text be improved? Delete any of the following which do not apply and feel free to add extras

  • Text broken down into smaller sections with more subsections
  • More screen shots
  • Less screen shots
  • More examples of the feature 'in operation'
  • A video
  • Some features are missing (if so state what they are)
  • More warnings/hints needed
  • A feature which could benefit from some 'How to's' (ie. as well a page which explains what a feature of the platform is, pages which come at it from the angle of 'I want to solve a problem' and in solving that problem a hub manager uses that feature).
  • Other (please add here)

Suggested New Draft
Use English version as template. This is most up to date.

I would like to be part of a larger User Guide group who re-write this section

  • Yes
  • No

Additional Context

Remove the description of 'Perform associated adjustments' (managing orders)

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

On page Features - Orders - View/Manage Orders in chapter 'Editing an order - Changing the Shipping Method' the description of 'Perform associated adjustments' should be removed, because this functionality will be/has been removed.

Note: This section had been added only recently, so you might not even have it in your language version.

grafik

Link to Release Notes
Will be included in v4.2.1:

Update 'White label' content to include all features

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Description
The 'White label' feature has been extended. Description of the following needs to be added:

  • Hide 'Groups' tab in shopfront
  • Create custom tab in shopfront
    • Title for custom tab
    • Content for custom tab

Which section would you like the new content to be added to?

  • Quick Start Guide
  • Features
  • Hub Management Tips (How to's)
  • Troubleshooting
  • Glossary
  • other- please state:

If 'Features' please state the subsection here

  • shopfront
    • white label

In which instance(s) do you know that users are adversely affected by this information being missing from the User Guide in its current form?

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

Suggested Draft of content to be added
If you would like to provide a draft (including or excluding screen shots) then feel free here. There is no obligation to do so.
Add a link to a Google doc of your draft if it is lengthy.

I would like to be part of a larger User Guide group who write this section

  • yes
  • no

Additional Context
Add any extra information here. If this affects your instance but not all instances which speak the same language as you, then adding in some context about how important the issue is for you is really helpful.

NEWCONTENT: Permalink of products

Admin Only: Language Checklist for when this Update is Complete

  • English
  • French
  • Catalan
  • Italian
  • Russian
  • Turkish
  • Spanish
  • Portuguese

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English

Description
In the admin area on the 'edit product' page there is a field called 'permalink'. I cannot find a description what this does and if it is actually working.

Which section would you like the new content to be added to?

  • Quick Start Guide
  • Features
  • Hub Management Tips (How to's)
  • Troubleshooting
  • Glossary
  • other- please state:

If 'Features' please state the subsection here
Products - Add products

In which instance(s) do you know that users are adversely affected by this information being missing from the User Guide in its current form?
Germany

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

Suggested Draft of content to be added

I would like to be part of a larger User Guide group who write this section

  • yes
  • no
  • happy to support and learn about the feature

Additional Context
I am wondering if this 'permalink' is some kind of 'deep link' which could be used for direct linking to products.

Wrong information regarding 'max fulfilled units' in bulk order management (BOM)

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English

Description
Source: https://openfoodnetwork.slack.com/archives/C0YJZHLLQ/p1646917409198119
I think we might have a typo on our user guide, on Bulk Order Management, under Max Fulfilled Units:
"If it’s below zero, it means that even the MAX order quantities won’t reach the threshold."
should read
"If it’s below 1, it means that even the MAX order quantities won’t reach the threshold."

What is the nature of the error?

  • Information (text) inaccurate
  • Screen shot inaccurate/out of date
  • Broken hyperlink
  • Spelling mistake
  • Other

URL of the page/section on which you have found inaccurate information
https://guide.openfoodnetwork.org/basic-features/products-1/group-buy-for-bulk-ordering#adjusting-orders-to-make-complete-batches

Screen shot of the error or copy and paste the incorrect text in here
"If it’s below zero, it means that even the MAX order quantities won’t reach the threshold."

Additional Context

Include 'White Label' feature

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

The feature 'White Label' needs to be explained in the guide.

Description
https://guide.openfoodnetwork.org/basic-features/shopfront/white-label-site

Which section would you like the new content to be added to?

  • Quick Start Guide
  • Features
  • Hub Management Tips (How to's)
  • Troubleshooting
  • Glossary
  • other- please state:

If 'Features' please state the subsection here

In which instance(s) do you know that users are adversely affected by this information being missing from the User Guide in its current form?

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

Suggested Draft of content to be added
If you would like to provide a draft (including or excluding screen shots) then feel free here. There is no obligation to do so.
Add a link to a Google doc of your draft if it is lengthy.

I would like to be part of a larger User Guide group who write this section

  • yes
  • no

Additional Context
Add any extra information here. If this affects your instance but not all instances which speak the same language as you, then adding in some context about how important the issue is for you is really helpful.

Add section to API Handbook for webhooks

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Which language version of the User Guide are you viewing? English

Description
A new feature has been released to set up webhooks triggered by an event (order cycle opened). I'd like to document this so that it is easy to discover and refer to.

This is different but similar to the API. Currently we have no documentation about API features, but I think it's time to create a section for this, to make it possible for any users to discover what options they can start to use.
Currently there's an API Handbook at https://ofn-user-guide.gitbook.io/ofn-api-handbook/. This section should be added there.

Which section would you like the new content to be added to?
I'm open to suggestions, but I think there should be a new top-level section (same level as "OFN API V1").
I can imagine it would be useful to create "how to" guides as well (eg how to send an email notification when order cycle opens).

In which instance(s) do you know that users are adversely affected by this information being missing from the User Guide in its current form?
Unknown

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

Suggested Draft of content to be added
Added to comment below.

I would like to be part of a larger User Guide group who write this section

  • yes
  • no

Improvement: warning of implications of reopening one OC rather than opening new order cycles

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English

Description
Features > Shopfront > Order Cycles > Order Cycles (For shops) > 'Open the shopfront'

URL of the page/section which you would like improved/updated
https://guide.openfoodnetwork.org/basic-features/shopfront/order-cycle/order-cycles-for-producers#open-the-shopfront

In which instance(s) do you know that users are adversely affected by this section of the User Guide in its current form?
Australia

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

How could the current text be improved? Delete any of the following which do not apply and feel free to add extras

  • More screen shots
  • More warnings/hints needed

Suggested New Draft

Click Create to save this order cycle.

{% hint style="warning" %} If the opening date of your order cycle has already lapsed then your shop front will be live immediately!
If you are not quite ready to open the shop, set the 'Opens At' date to a time in the future. {% endhint %}

For periodic, repetitive order cycles, you can copy an existing order cycle and change the dates, to make the process quicker. Select the icon with two sheets of paper to the right of the table as highlighted below:

occpy (1)

Order cycles will display as green when they are active, yellow when scheduled for a future date, and grey when they have closed. If an order cycle closed over one month ago, it will no longer display on this list. To view all of your past order cycles click show 30 more days or show 90 more days at the bottom of the list.

{% hint style="warning" %} Re opening an order cycle to re open a shopfront can cause confusion at customer checkout, see the warning shown below. For periodically opening shopfronts, duplicate or create new order cycles each time you open the shop rather than editing the open and close dates of one order cycle. {% endhint %}

Customers will be advised when they have already ordered in an order cycle, even if the order cycle was closed for some time before being reopened:
pop up in checkout

I would like to be part of a larger User Guide group who re-write this section

  • Yes
  • No
    Happy to be part of a group if its needed

Additional Context
This could also be added to the 'Open the shopfront' section of Order Cycles (for hubs): https://guide.openfoodnetwork.org/basic-features/shopfront/order-cycle/order-cycles-for-hubs#open-the-shopfront

NEWCONTENT: Add Farmers Market to Quick Start Section

Admin Only: Language Checklist for when this Update is Complete

  • English
  • French
  • Catalan
  • Italian
  • Russian
  • Turkish
  • Spanish
  • Portuguese

Tell us what you would like to see

Which language version of the User Guide are you viewing?
all

Description
A brief description of what is missing from the current user guide.

Quick Start guide for setting up a farmers market

Which section would you like the new content to be added to? Please delete all apart from the appropriate section(s)
Quick Start Guide

If 'Features' please state the subsection here

In which instance(s) do you know that users are adversely affected by this information being missing from the User Guide in its current form?
Mainly : Australia, USA, Canada,

How would you rate the impact of the current version of the User Guide on your instance?

High volume of support queries for Canadian instance

Prevents/deters new enterprises from setting up in Canada

Suggested Draft of content to be added
If you would like to provide a draft (including or excluding screen shots) then feel free here. There is no obligation to do so.
Add a link to a Google doc of your draft if it is lengthy.

I would like to be involved
If you would like to be part of a larger User Guide group who write this new content then state so here.

Additional Context
Add any extra information here. If this affects your instance but not all instances which speak the same language as you, then adding in some context about how important the issue is for you is really helpful.

Broken link "refund management"

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Which language version of the User Guide are you viewing?

French

Description

On page https://guide.openfoodnetwork.org/v/fr/basic-features/shopfront/payment-methods#stripe , last part "Gestion des remboursements", the link to https://guide.openfoodnetwork.org/v/fr/basic-features/shopfront/payment-methods does not match its description "Consultez la page dédiée à ce sujet"

What is the nature of the error?

  • Information (text) inaccurate
  • Screen shot inaccurate/out of date
  • Broken hyperlink
  • Spelling mistake
  • Other

URL of the page/section on which you have found inaccurate information
Please provide a link to the page/section (subsection if possible) in the user guide on which you have found the error.

https://guide.openfoodnetwork.org/v/fr/basic-features/shopfront/payment-methods#stripe

Screen shot of the error or copy and paste the incorrect text in here

Additional Context
Add any extra information here. If this affects your instance but not all instances which speak the same language as you, then adding in some context about how important the issue is for you is really helpful.

Add link to API Handbook

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Which language version of the User Guide are you viewing?
all

Description
There is no link to the API Handbook. It was requested to add it here: https://openfoodnetwork.slack.com/archives/C0YJZHLLQ/p1671052567026899

Which section would you like the new content to be added to?

  • Quick Start Guide
  • Features
  • Hub Management Tips (How to's)
  • Troubleshooting
  • Glossary
  • other- please state: Complementary software and tools

If 'Features' please state the subsection here

In which instance(s) do you know that users are adversely affected by this information being missing from the User Guide in its current form?

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

Suggested Draft of content to be added
If you would like to provide a draft (including or excluding screen shots) then feel free here. There is no obligation to do so.
Add a link to a Google doc of your draft if it is lengthy.

I would like to be part of a larger User Guide group who write this section

  • yes
  • no

Additional Context

IMPROVEMENT

Tell us what you would like to see

We've had a number of customers who have been confused by how to use Price Sack - we're hoping some descriptions on the Price Calculator screen shot will help people to get the settings right

Description
Features > Shopfront > Shipping Methods > Fee Calculator

  • Suggesting edits to Price Sack section

URL of the page/section which you would like improved/updated
https://openfoodnetworkaus.slack.com/archives/D01DZ3BCW93/p1635392293003400

In which instance(s) do you know that users are adversely affected by this section of the User Guide in its current form?
Australia

How would you rate the impact of the current version of the User Guide on your instance?

  • Occasional support query
  • Deterring users from using this feature/causing confusion

How could the current text be improved? Delete any of the following which do not apply and feel free to add extras

  • Updated screen shot with explanation
  • Update text to match language on platform eg. Minimal

Suggested New Draft
Renata from Australia has submitted a draft called 'Price Sack image update with descriptions' in the user guide that can be reviewed. Copy of draft below:

Price Sack: This is a flexible shipping fee method that allows you to reward shoppers who spend over a ‘minimal amount’ by applying a shipping discount. If the shopper spends less than the ‘minimal amount’ you can set what shipping fee they pay.

Minimal Amount: If the order total is below this amount, no discount is applied. If the order is above this amount, the discount will be applied at checkout.

'Normal Amount': This will be the shipping fee applied to sales below the 'Minimal Amount'.

‘Discount Amount’: This will be the shipping fee applied to sales above the 'Minimal Amount'.

Price Sack

I would like to be part of a larger User Guide group who re-write this section

  • Yes

Additional Context
Context: in the lead up to Xmas we are wanting to promote this feature as it is a great option for enterprises who want to offer something special to customers during holiday shopping. We want to link to this section of the user guide in our Xmas comms. I imagine non english speaking instances may also find it useful to add descriptions on the image of the price sack calculator

Include tax settings to 'setting up a shipping method'

Admin Only: Language Checklist for when this Update is Complete

  • English
  • French
  • Catalan
  • Italian
  • Russian
  • Turkish
  • Spanish
  • Portuguese
  • German

Tell us what you would like to see

Since PR [Adjustments] Shipping tax #6924 has been merged the tax configuration for a shipping fees is defined when setting up a shipping method. It is not an instance wide setting anymore.

Which language version of the User Guide are you viewing?
English

Description
Shopfront - Shipping methods

URL of the page/section which you would like improved/updated
https://guide.openfoodnetwork.org/basic-features/shopfront/shipping-methods#setting-up-a-shipping-method

In which instance(s) do you know that users are adversely affected by this section of the User Guide in its current form?

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

How could the current text be improved? Delete any of the following which do not apply and feel free to add extras

  • Some features are missing (if so state what they are)

Suggested New Draft

I would like to be part of a larger User Guide group who re-write this section

  • Yes
  • No

Additional Context

Unable to search OFN-User Guide

Description

Workaround

Only workaround is to page through the guide for what you want.

Severity

s2 ??

bug-s1: a critical feature is broken: checkout, payments, signup, login
bug-s2: a non-critical feature is broken, no workaround
bug-s3: a feature is broken but there is a workaround
bug-s4: it's annoying, but you can use it
bug-s5: we can live with it, only a few users impacted

https://github.com/openfoodfoundation/openfoodnetwork/wiki/Bug-severity
-->

Your Environment

  • Version used:
  • Browser name and version:
  • Operating System and version (desktop or mobile):

Possible Fix

NEWCONTENT: How to manage multiple collection points and order cycles while distributing stock evenly

Admin Only: Language Checklist for when this Update is Complete

  • English
  • French
  • Catalan
  • Italian
  • Russian
  • Turkish
  • Spanish
  • Portuguese

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English, French, Catalan, Italian, Russian, Turkish, Spanish, Portuguese...

Description

See Slack conversation here:
https://openfoodnetwork.slack.com/archives/CG7NJ966B/p1604704922409300

Which section would you like the new content to be added to? Please delete all apart from the appropriate section(s)

Hub Management Tips (How to's)

If 'Features' please state the subsection here

In which instance(s) do you know that users are adversely affected by this information being missing from the User Guide in its current form?
Global

How would you rate the impact of the current version of the User Guide on your instance?
Occasional support query
Prevents/deters new enterprises from setting up

Suggested Draft of content to be added
If you would like to provide a draft (including or excluding screen shots) then feel free here. There is no obligation to do so.
Add a link to a Google doc of your draft if it is lengthy.

I would like to be involved
If you would like to be part of a larger User Guide group who write this new content then state so here.

Additional Context
Add any extra information here. If this affects your instance but not all instances which speak the same language as you, then adding in some context about how important the issue is for you is really helpful.

Include 'Vouchers' feature

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

The feature 'Vouchers' needs to be explained in the guide.

Which language version of the User Guide are you viewing?

Description
A brief description of what is missing from the current user guide.

Which section would you like the new content to be added to?

  • Quick Start Guide
  • Features
  • Hub Management Tips (How to's)
  • Troubleshooting
  • Glossary
  • other- please state:

If 'Features' please state the subsection here
Shopfront

In which instance(s) do you know that users are adversely affected by this information being missing from the User Guide in its current form?

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

Suggested Draft of content to be added
If you would like to provide a draft (including or excluding screen shots) then feel free here. There is no obligation to do so.
Add a link to a Google doc of your draft if it is lengthy.

I would like to be part of a larger User Guide group who write this section

  • yes
  • no

Additional Context
Add any extra information here. If this affects your instance but not all instances which speak the same language as you, then adding in some context about how important the issue is for you is really helpful.

Visible in Search section updated with new enterprise visibility options

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Visible in Search section updated inline with release v4.1.27: Change enterprise visibility scope #9087
Current wording references options 'Visible' and 'Not visible' which have been replaced by 'Public', 'Hidden' and 'Hide all references' with release v4.1.27

URL for User Guide section: https://guide.openfoodnetwork.org/basic-features/enterprise-profile/enterprise-settings#primary-details
Pathway: Features > Enterprise Profile > Enterprise Settings > Primary Details

Link to Release Notes
Please provide a link to the release notes here: Release v4.1.27

Suggested Content

Visible in Search: If your profile is ready to go public, select 'public', and your business will appear in the OFN's directory and map. Selecting 'hidden' will hide your profile in search and maps but still allow references in other shop profiles. 'Hide all references' will make your enteprise completely hidden on the platform.

'Total Refund' steps in incorrect order

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English

Description
In the Total Refunds section, the order of steps given is to void the payment first, then cancel the order.

However this:

  • generates the order cancellation email to the customer which says "Your order was unpaid so no refund has been made", because the payment has already been refunded; and
  • leaves the order with Shipment 'pending'.

If the order is cancelled first then payment voided, the email says 'Your order was paid so [shop] has refunded the full amount'. The order then shows Shipment as cancelled.

The section also does not mention the 'Cancel' button and the option to choose whether to send cancellation email and restock items.

What is the nature of the error?

  • Information (text) inaccurate
  • Screen shot inaccurate/out of date
  • Broken hyperlink
  • Spelling mistake
  • Other

URL of the page/section on which you have found inaccurate information
https://guide.openfoodnetwork.org/basic-features/orders/refunds-and-adjusting-payments#refunds

Screen shot of the error or copy and paste the incorrect text in here
Whole section would need adjustment.

Additional Context

Description of registration is outdated

Admin Only: Language Checklist for when this Update is Complete

  • English
  • French
  • Catalan
  • Italian
  • Russian
  • Turkish
  • Spanish
  • Portuguese

Tell us what you would like to see

The description of the registration process is outdated.

Which language version of the User Guide are you viewing?
English

Description

  • the feature 'locate on map' is not described
  • the registration banner shows at the bottom of the screen (not at the top as written and shown)
  • screenshots are outdated

What is the nature of the error?

  • Information (text) inaccurate
  • Screen shot inaccurate/out of date
  • Broken hyperlink
  • Spelling mistake
  • Other

URL of the page/section on which you have found inaccurate information
https://guide.openfoodnetwork.org/basic-features/register-and-create-your-profile

Screen shot of the error or copy and paste the incorrect text in here
grafik
grafik

Additional Context
Two PRs have been submitted which will required updated screenshots as well, if they get merged. So maybe check again from time to time and wait for them?

Steps for Taking Orders on Credit

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Steps on How To 'Take orders on Credit' added to the Hub Management Tips - How To's section of the user guide.

Which language version of the User Guide are you viewing?
English

Description
A brief description of what is missing from the current user guide.

Although 'Taking Orders on Credit' is not-yet built into OFN, with a few quick steps it is possible to allow customers to pay with prepaid credit on OFN. In a nutshell, this involves first creating a credit product that the customer checks out with. The store manager will then go into the backoffice and ‘delete’ this product putting ‘credit’ on the customer account. Future orders can then be ‘paid’ with the credit on the account.

It is important to have these steps in the user guide so users know that this is possible in OFN and can follow the steps to setup for their customers.

Which section would you like the new content to be added to?

  • Quick Start Guide
  • Features
  • Hub Management Tips (How to's)
  • Troubleshooting
  • Glossary
  • other- please state:

If 'Features' please state the subsection here

In which instance(s) do you know that users are adversely affected by this information being missing from the User Guide in its current form?
Canada

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

Suggested Draft of content to be added
It has already been drafted and has been added to the English user guide through Gitbooks - https://app.gitbook.com/o/-L9rgjXCVdbnhSow2XnR/s/-L9rgk4wEweX_zxXIzmW-887967055/hub-management-tips/how-tos/take-orders-on-credit

I would like to be part of a larger User Guide group who write this section

  • yes
  • no

Additional Context
Add any extra information here. If this affects your instance but not all instances which speak the same language as you, then adding in some context about how important the issue is for you is really helpful.

IMPROVEMENT: reports

Admin Only: Language Checklist for when this Update is Complete

  • English
  • French
  • Catalan
  • Italian
  • Russian
  • Turkish
  • Spanish
  • Portuguese

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English

Description
Name of the section/subsection you are referring to.
Reports

URL of the page/section which you would like improved/updated
Please provide a link to the page/section in the user guide which you and your users would benefit from seeing re-written and updated.

In which instance(s) do you know that users are adversely affected by this section of the User Guide in its current form?
Global, Australia, USA, Canada, France, India, UK, Columbia, Brazil, Russia, Turkey....
all

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

How could the current text be improved? Delete any of the following which do not apply and feel free to add extras

  • Text broken down into smaller sections with more subsections
  • More screen shots
  • Less screen shots
  • More examples of the feature 'in operation'
  • A video
  • Some features are missing (if so state what they are)
  • More warnings/hints needed
  • A feature which could benefit from some 'How to's' (ie. as well a page which explains what a feature of the platform is, pages which come at it from the angle of 'I want to solve a problem' and in solving that problem a hub manager uses that feature).
  • Other (please add here)

Suggested New Draft
If you would like to provide a draft alternative (including or excluding screen shots) then feel free here. There is no obligation to do so.
Add a link to a Google doc of your new draft if it is lengthy.

Include the information in this doc

I would like to be part of a larger User Guide group who re-write this section

  • Yes
  • No

Additional Context
Add any extra information here. If this affects your instance but not all instances which speak the same language as you, then adding in some context about how important the issue is for you is really helpful.

IMPROVEMENT: Reports Section

Admin Only: Language Checklist for when this Update is Complete

  • English
  • French
  • Catalan
  • Italian
  • Russian
  • Turkish
  • Spanish
  • Portuguese

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English

Description
Reports

URL of the page/section which you would like improved/updated
Please provide a link to the page/section in the user guide which you and your users would benefit from seeing re-written and updated.

In which instance(s) do you know that users are adversely affected by this section of the User Guide in its current form?
Global

How would you rate the impact of the current version of the User Guide on your instance?

User misunderstandings around this issue result in those enterprises affected moving away from OFN...

How could the current text be improved? Delete any of the following which do not apply and feel free to add extras

  • Text broken down into smaller sections with more subsections
  • More screen shots
  • More examples of the feature 'in operation'
  • A video
  • A feature which could benefit from some 'How to's' (ie. as well a page which explains what a feature of the platform is, pages which come at it from the angle of 'I want to solve a problem' and in solving that problem a hub manager uses that feature).

Rewrite this entire section when Reports are updated on the platform. See here for discourse post:
https://community.openfoodnetwork.org/t/reports-project/1935/23

Suggested New Draft
If you would like to provide a draft alternative (including or excluding screen shots) then feel free here. There is no obligation to do so.
Add a link to a Google doc of your new draft if it is lengthy.

I would like to be involved
If you would like to be part of a larger User Guide group who re-write this section then state so here.

Additional Context
Add any extra information here. If this affects your instance but not all instances which speak the same language as you, then adding in some context about how important the issue is for you is really helpful.

Tracking information is not described in the user guide

Admin Only: Language Checklist for when this Update is Complete

  • English
  • French
  • Catalan
  • Italian
  • Russian
  • Turkish
  • Spanish
  • Portuguese
  • German

Tell us what you would like to see

There should be an explanation what the "tracking" field is for on the admin/orders/Rxxx/edit page and where this information will be displayed.

Which language version of the User Guide are you viewing?
English

Description
Explanation of the tracking field on the admin/orders/Rxxx/edit page and where this information will be displayed.

Which section would you like the new content to be added to?

  • Quick Start Guide
  • Features
  • Hub Management Tips (How to's)
  • Troubleshooting
  • Glossary
  • other- please state:

If 'Features' please state the subsection here
orders - view orders - editing an order

In which instance(s) do you know that users are adversely affected by this information being missing from the User Guide in its current form?
Germany

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

Suggested Draft of content to be added
t.b.d.

I would like to be part of a larger User Guide group who write this section

  • yes
  • no

Additional Context

IMPROVEMENT: Typo "dong"

Admin Only: Language Checklist for when this Update is Complete

  • English
  • French
  • Catalan
  • Italian
  • Russian
  • Turkish
  • Spanish
  • Portuguese

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English

Description
Group Buy - for bulk ordering
Typo in 2nd paragraph, 2nd sentence: "By dong so"; Actually there is something wrong in that whole sentence.

URL of the page/section which you would like improved/updated
https://guide.openfoodnetwork.org/basic-features/products-1/group-buy-for-bulk-ordering

In which instance(s) do you know that users are adversely affected by this section of the User Guide in its current form?
All english speaking

Suggested New Draft
By doing so

IMPROVEMENT: 'Notes' in the 'Search' page of editing products not explained

Admin Only: Language Checklist for when this Update is Complete

  • English
  • French
  • Catalan
  • Italian
  • Russian
  • Turkish
  • Spanish
  • Portuguese

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English

Description
Section: Features - Products - Add products - Edit your products - Search keywords

The text field 'notes' is not explained here. So it is unclear what these notes are being used for. Is it just for the hub manager's notes to himself/herself? Or will these notes be displayed in some search results or anything?

URL of the page/section which you would like improved/updated
https://guide.openfoodnetwork.org/basic-features/products-1/products#search-keywords
very bottom

In which instance(s) do you know that users are adversely affected by this section of the User Guide in its current form?
Germany

How would you rate the impact of the current version of the User Guide on your instance?

  • High volume of support queries
  • Occasional support query
  • Prevents/deters new enterprises from setting up
  • User misunderstandings around this issue result in those enterprises affected moving away from OFN...

How could the current text be improved? Delete any of the following which do not apply and feel free to add extras

  • Just add a short explaining sentence.

Suggested New Draft

I would like to be part of a larger User Guide group who re-write this section
Happy to support if needed.

Additional Context

Remove link to embedded shop fronts on page 'Quick Start Guides - Shop'

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English

Description
Embedded shop fronts are not supported anymore. So the reference and the broken link should be removed.

What is the nature of the error?

  • Information (text) inaccurate
  • Screen shot inaccurate/out of date
  • Broken hyperlink
  • Spelling mistake
  • Other

URL of the page/section on which you have found inaccurate information
https://guide.openfoodnetwork.org/quick-start-guides/producer-shop-quick-setup-guide

Screen shot of the error or copy and paste the incorrect text in here
You would like to embed the OFN shop front in your website.

Additional Context

Update the blue information box about automatically updating stock levels when cancelling an order

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English

Description
The blue information box about automatically updating stock levels when cancelling an order is not up to date. In a recent software update we added the option to select if the cancelled products should be restocked or not.

What is the nature of the error?

  • Information (text) inaccurate
  • Screen shot inaccurate/out of date
  • Broken hyperlink
  • Spelling mistake
  • Other

URL of the page/section on which you have found inaccurate information
https://guide.openfoodnetwork.org/basic-features/orders/refunds-and-adjusting-payments#total-refund

Screen shot of the error or copy and paste the incorrect text in here
image

Additional Context
image

Update NZ contact details from "Permakai Ltd. (for the time being)" to "Systems Commons Ltd. (for the time being)"

Admin Only: Language Checklist for when this Update is Complete

  • Catalan
  • English
  • French
  • German
  • Italian
  • Portuguese
  • Russian
  • Spanish
  • Turkish

Tell us what you would like to see

Which language version of the User Guide are you viewing?
English

Description
Is it possible to get the NZ contact details updated from "Permakai Ltd. (for the time being)" to "Systems Commons Ltd. (for the time being)" under the "Access to platform provided by" column - thank you.

What is the nature of the error?

  • Information (text) inaccurate
  • Screen shot inaccurate/out of date
  • Broken hyperlink
  • Spelling mistake
  • Other

URL of the page/section on which you have found inaccurate information
https://guide.openfoodnetwork.org/local-ofn-organizations-and-contacts

Screen shot of the error or copy and paste the incorrect text in here
see above

Additional Context

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.