Skip to content

[Update] Readme and Odoo appstore visibility #4

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.

Sign up for GitHub

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

Open
Fuchur777 wants to merge 8 commits into
base: 11.0
Choose a base branch
from
Open

[Update] Readme and Odoo appstore visibility #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bb3fca2
[Add] New screenshot and Odoo App Store Files
Fuchur777 Mar 23, 2018
31ccfa0
[Add] Odoo App Store Images
Fuchur777 Mar 23, 2018
30eec91
[Update] Issue location & CSS Screenshot
Fuchur777 Mar 23, 2018
ac55cc2
Update README.rst
Fuchur777 Mar 23, 2018
ca5aee4
[Add] Odoo App Store HTML Description
Fuchur777 Mar 23, 2018
1accc7b
[Update] Index HTML bad syntax
Fuchur777 Mar 23, 2018
53af2ed
Fix RST format
Fuchur777 Mar 29, 2018
3073631
Fix Bootstrap Layout
Fuchur777 Mar 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion website_theme_flexible/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ You can set the colors, fonts and layout you want (not limited by presets).
Screenshots
===========

CSS options
-----------

.. image:: /website_theme_flexible/static/description/screenshot5.jpg
:alt: Layout

Layout options
--------------

Expand Down Expand Up @@ -65,7 +71,7 @@ Bug Tracker
===========

Bugs are tracked on `GitHub Issues
<https://github.com/OCA/website/issues>`_. In case of trouble, please
<https://github.com/OCA/website-themes/issues>`_. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.

Expand Down
4 changes: 4 additions & 0 deletions website_theme_flexible/__manifest__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
'depends': [
'website'
],
'images': [
'static/description/flexible_poster.jpg',
'static/description/flexible_screenshot.jpg',
],
'data': [
'views/res_config_settings_view.xml',

Expand Down
Binary file added website_theme_flexible/static/description/flexible_poster.jpg
View file
Open in desktop
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 website_theme_flexible/static/description/flexible_screenshot.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
246 changes: 246 additions & 0 deletions website_theme_flexible/static/description/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,246 @@
<section id="website_theme_flexible_description" class="container">
Copy link
Member

@pedrobaeza pedrobaeza Mar 23, 2018

Choose a reason for hiding this comment

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

This file is not needed having README.rst

Copy link
Author

@Fuchur777 Fuchur777 Mar 24, 2018

Choose a reason for hiding this comment

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

It is needed for the Odoo App Store.
Modules without index.html will be rated lower then modules with.

Copy link
Member

@pedrobaeza pedrobaeza Mar 24, 2018

Choose a reason for hiding this comment

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

Where is that stated?

Copy link
Author

@Fuchur777 Fuchur777 Mar 24, 2018

Choose a reason for hiding this comment

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

First:
See point 4 from an email App Developers received beginning of the year.

From: [email protected]
Sent: Thursday, 18 January, 2018 14:26:59
Subject: Let's improve the Apps Store - Apps Review

Dear App Publishers,

We hope this email finds you well. Back in December we shared with you our vision for the future of the Odoo Apps Store, including building more customer trust (claims, reimbursement process), improving services to vendors and differentiating the apps with more transparency and quality checks.

We also announced the first wave of App reviews based on the new automatic scoring system, which will arrange the apps in order of ranking. As a reminder, every app page of the store has been reviewed and scored based on 5 criteria, and depending on the score received, the app page will be displayed higher or lower in the default App listing.

To summarize: only 5/5 apps, fully complying with the Guidelines, can appear at the top of the default search.

Below you'll find the 5 criteria: 
1. The module has no icon 
2. The module has no cover image (thumbnail) License is not set in the module manifest 
3. The module has a rating that is quite poor (lower than 3) 
4. The module has a non-html description (like rst for example), as we'd like to promote beautiful descriptions
5. The tie breaker between apps with the same score remains the best sellers.

Please take a moment to read the above criteria and review your App pages accordingly. Upon connecting to your App Store Account and visiting the description page of each of your apps, you should see your score, if you didn't reach 5 out of 5,  and the elements that require amendments for your ranking to improve.

Thank you for all your work.

Kind regards,

Cécile Collart
Content Marketer at Odoo

Second: Check out how the RST is rendered in the App Store now. Already depreciated.

Copy link
Member

@pedrobaeza pedrobaeza Mar 25, 2018

Choose a reason for hiding this comment

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

Thanks for the info. This is a proposal, but not yet done. I worry about that, as an HTML is difficult to maintain. RST can be a rich format also. The way I see to go with this is to auto-generate an HTML from RST instead of manually create one, or better yet, forget totally the Odoo Apps and go for OCA Apps Browser (OCA/apps-store#7).

Meanwhile, I won't oppose to this.

Copy link
Author

@Fuchur777 Fuchur777 Mar 26, 2018

Choose a reason for hiding this comment

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

Thanks for pointing me to the "OCA AppStore" module. That is a great development.

However I do feel OCA developed apps should also be highly visible in the Odoo App Store. Preferably top ranked to. And aside great code, Odoo S.A. would love to see a good presentation.

As my programming skills are sub OCA standards helping out getting the Apps presented as good as possible can be my OCA contribution ;-)

Copy link

@zeroheure zeroheure May 21, 2018

Choose a reason for hiding this comment

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

About index.html and scoring, it is official, read Odoo vendor guidelines (look for "Scoring of Apps")
https://www.odoo.com/apps/vendor-guidelines

<div class="row text-center mb64">
<div class="col-md-12">
<p>
Theme Flexible is the first OCA published frontend website theme.<br/><br>
It is extremely flexible in Font and Color use. No more presets. It still uses the power of Bootstrap, LESS and CSS3.<br/><br>
OCA created a theme you can build your next level Odoo websites on.
</p>
</div>
</div>
<hr class="mb32 mt32" />
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h2>Main Features</h2>
</div>
</div>
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h3>Custom CSS</h3>
</div>
</div>
<img class="img-responsive" src="screenshot5.jpg" alt="CSS editor in the configuration menu" />
<hr class="mb32 mt32" />
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h3>Layout Options</h3>
</div>
</div>
<div class="row mt64 mb64 text-center">
<div class="col-xs-8">
<img class="img-responsive" src="screenshot1.png" alt="Options to customize your website layout" />
</div>
<div class="col-xs-4">
<ul><li>
Layout: <span class="italic">Full Width, boxed, Postcard</span>
</li><li>
Block Corner Radius: <span class="italic">Set section rounded corners</span>
</li><li>
Background Color: <span class="italic">Set the page Background color</span>
</li><li>
Footer Color: <span class="italic">Set the page Background Footer color</span>
</li><li>
Link Color: <span class="italic">Set main href font color</span>
</li><li>
Link Color In Footer: <span class="italic">Set footer href font color</span>
</li></ul>
</div>
</div>
<hr class="mb32 mt32" />
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h3>Menu Options</h3>
</div>
</div>
<div class="row mt64 mb64 text-center">
<div class="col-xs-8">
<img class="img-responsive" src="screenshot2.png" alt="Options to set the looks of your menu" />
</div>
<div class="col-xs-4">
<ul><li>
Company Logo / Website Name Alignment: <span class="italic">Select if you want Company Logo or Name and if it should be on the left or rightside of the menu</span>
Copy link
Member

@tarteo tarteo Mar 27, 2018

Choose a reason for hiding this comment

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

I think using <i></i> is the same. Can you use this please?

Copy link
Author

@Fuchur777 Fuchur777 Mar 29, 2018

Choose a reason for hiding this comment

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

https://www.w3.org/TR/html5/text-level-semantics.html#the-i-element
So I prefer to use CSS to style italic

</li><li>
Menu Alignment: <span class="italic">Left, Center, Right</span>
</li><li>
Sticky: <span class="italic">When scrolling down on a page should the menu stay visible</span>
</li><li>
Background Color: <span class="italic">Set the menu Background color</span>
</li><li>
Font color: <span class="italic">Set menu font color</span>
</li></ul>
</div>
</div>
<hr class="mb32 mt32" />
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h3>Color Options</h3>
</div>
</div>
<img class="img-responsive" src="screenshot3.png" alt="Set your default colors and shades" />
<p>
Set your default 5 colors and Shades. Any color can be selected and you determine the shade grade in percentage of that color. Giving you freedom in color presets!
</p>
<hr class="mb32 mt32" />
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h3>Font options</h3>
</div>
</div>
<img class="img-responsive " src="screenshot4.png" alt="Font options" />
<p>
Set your fonts for Normal, Code, H1-6 and menu. Select Italic or Underline<br/>
If you configure Google Fonts correctly (See configuration below) you can select all Google Fonts, by inputting the Google Font name as it appears on <a href="https://fonts.google.com/" target="_blank">https://fonts.google.com/</a>
</p>
<hr class="mb32 mt32" />
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h2>Configuration</h2>
</div>
</div>
<img class="img-responsive" src="screenshot0.png" alt="Set the Google Font API" />
<p>
To configure this module, you need to set a Google Font API in the Odoo Website Backend Settings.<br/>
Anyone can obtain such an API key for free here: <a href="https://developers.google.com/fonts/docs/developer_api" target="_blank">https://developers.google.com/fonts/docs/developer_api</a>
</p>
<hr class="mb32 mt32" />

<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h2>Usage</h2>
</div>
</div>
<p>To use this module, you need to:</p>
<ol>
<li>Go to the website</li>
<li>click in menu on 'Customize'</li>
<li>click on 'Customize Theme'</li>
<li>change the options to your preference</li>
<li>click on 'Apply'</li>
</ol>

<hr class="mb32 mt32" />
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h2>Bug Tracker</h2>
</div>
</div>
<p>
Bugs are tracked on <a href="https://github.com/OCA/website/issues" target="_blank">GitHub Issues</a>. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smash it by providing detailed and welcomed feedback.
</p>
<hr class="mb32 mt32" />
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h2>Contribute</h2>
</div>
</div>
<p>
We welcome improvements and suggestions to this theme! See the code on <a href="https://github.com/OCA/website-themes/tree/11.0/website_theme_flexible" target="_blank">GitHub</a>. Feel free to make suggestions or do a pull request. We know with your help this theme can be better than it is already!
</p>
<hr class="mb32 mt32" />
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h2>Credits</h2>
</div>
</div>
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h3>Contributors</h3>
</div>
</div>
<p>
<a href="mailto:[email protected]?Subject=I%20want%20to%20declare%20you%20my%20love%20to%20you,%20due%20to%20your%20contribution%20on%20OCA%20regarding%20Theme%20Flexible">Dennis Sluijk</a><br/>
<a href="mailto:[email protected]?Subject=I%20want%20to%20declare%20you%20my%20love%20to%20you,%20due%20to%20your%20contribution%20on%20OCA%20regarding%20Theme%20Flexible">Frank Schellenberg</a><br/><br/>
Do not contact contributors directly about support or help with technical issues.
</p>
<hr class="mb32 mt32" />
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h3>Funders</h3>
</div>
</div>
<p>
The development of this module has been financially supported by: <a href="https://onestein.nl">Onestein B.V.</a>
</p>
<hr class="mb32 mt32" />
<div class="row text-center mt64 mb64">
<div class="col-md-12">
<h3>Maintainer</h3>
</div>
</div>
<p>
<a href="https://odoo-community.org" target="_blank"><img src="https://odoo-community.org/logo.png" alt="Odoo Community Association"/></a><br/><br/>
This module is maintained by the OCA.<br/><br/>
OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.<br/><br/>
To contribute to this module, please visit <a href="https://odoo-community.org" target="_blank">https://odoo-community.org</a>.
</p>
<hr class="mb32 mt32" />
</section>

<style>
#website_theme_flexible_description{
padding-top: 40px;
font-size: 1.4rem;
overflow-x: hidden;
}
#website_theme_flexible_description img{
pointer-events: none;
vertical-align: middle;
display: block;
max-width: 80%;
height: auto;
margin: 1em auto;
}
#website_theme_flexible_description p{
max-width: 600px;
position: relative;
display: block;
margin: 1em auto;
}
#website_theme_flexible_description ol, #website_theme_flexible_description ul{
max-width: 600px;
position: relative;
display: block;
margin: 1em auto;
text-align: left;
}
#website_theme_flexible_description h2{
color: #1c355e;
font-size: 3em;
font-weight: 500;
letter-spacing: -2px;
word-spacing: -4px;
}
#website_theme_flexible_description h3{
color: #1c355e;
font-size: 2em;
font-weight: 300;
letter-spacing: -2px;
word-spacing: -4px;
}
hr{
color: #4d4e53;
background-color: #4d4e53;
height: 1px;
}
.text-center {
text-align: center;
}
.mt16{
margin-top: 16px;
}
.mt64{
margin-top: 64px;
}
.mb16{
margin-bottom: 16px;
}
.mb64{
margin-bottom: 64px;
}
.mb32{
margin-bottom: 32px;
}
.italic{
font-style: italic;
}
</style>
Binary file added website_theme_flexible/static/description/screenshot5.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.