Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cirro core] extend the app details page for spaces #38

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Binary file added src/images/card-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/space-description.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/space-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions src/pages/docs/features/branding_and_promotion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## Mandatory information upon space creation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where should we link this article?

Upon creating your space, you need to provide some mandatory information. You are to define the **type of work** (or category) available within your space. There is a free text field available for this purpose, that offers a set list of options via autocomplete, but you can also create your own value. Please note, a space can have only one category. You need to add a **short description** of your space in a free text field. It is important to keep it short (there is a limit of 180 characters), as there is a separate rich text field to provide your **space description** with the possibility of uploading pictures. You need to provide your **interface languages** to be used. Languages (or locales) are displayed in a multi-select field and those already in use can be excluded from the select options.

Your space description needs to contain the **company name**, a **link** to a publicly available website or landing page, a **support contact email address** and **Social links**.

![Space description](https://github.com/edinalakatos/cirro-guides/blob/Cirro-Core%5D-Extend-the-app-details-page-for-Spaces/src/images/space-description.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should link to the internal path and not github


## Visibility
The **visibility** of your space is defined by community membership. Users with access to your space see a full, detailed description. For those without access, the space card is not visible at all. Upon following the link to the restricted space, a flash message is displayed for them.

Spaces are displayed in card view and detailed view.
**Card view** contains limited information compared to detailed view:
* type of work that is available within the space
* 'Gigs available' with numeric details
* 'Gigs completed' with numeric details
* 'Details' link leading to the details page of the given space

![Card view](https://github.com/edinalakatos/cirro-guides/blob/Cirro-Core%5D-Extend-the-app-details-page-for-Spaces/src/images/card-view.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link should not point to github but to the path within the app


**Detailed view** displays the following information:
* company name
* type of work that is available within your space
* information on when the user joined the given Space
* short description
* 'Gigs available' and 'Gigs completed' with numeric details
* space description
* contact information
* supported interface languages

![Detailed view](https://github.com/edinalakatos/cirro-guides/blob/Cirro-Core%5D-Extend-the-app-details-page-for-Spaces/src/images/space-details.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link should not point to github but to the path within the app


## Access
Users can **join your space** either via card view by hitting 'Join' button. Upon joining a space this way, a flash message is displayed. The other access method is via the app details page by hitting the 'Join' button. This way, there is no flash message displayed.