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.

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

Jump to bottom

Add dataset to api doc #823

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add dataset to api doc #823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0945ce9
Odx 227 dataset app improve homepage with direct devtool page button …
QuentinMllt Jun 6, 2023
eff4634
Odx 229 dataset app add dataset tile into developer s tools page
QuentinMllt Jun 6, 2023
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
10 changes: 6 additions & 4 deletions content/apps/app-developer-tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# App developer tools

## Getting Started with Sample Apps
<div style="display:none" class="to-remove">

## API tools
## Start with Sample Apps

## Test your App

## Ease API access

## Diving into an App
## Dive into an App
</div>

314 changes: 314 additions & 0 deletions content/img/illustrations/illus--groups.svg
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.
35 changes: 10 additions & 25 deletions src/index.handlebars
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<h1 class="emphasis">Build Apps to ease the connection with Akeneo PIM</h1>
<p>Follow our step-by-step guide to create an app and use OAuth 2.0</p>
<a class="btn btn-primary" href="/apps/homepage.html">Build an App</a>
<a id="dev-tools-btn" class="btn btn-primary" href="/apps/app-developer-tools.html">Developer tools</a>
</div>
<div class="hidden-xs hidden-sm col-md-6 col-lg-7">
<img class="img-responsive img-banner" src="img/illustrations/illus--main-banner-apps.svg"></img>
Expand Down Expand Up @@ -41,33 +42,17 @@
</div>
<div class="row">
<div class="col-xs-12 col-md-6 col-lg-6">
<div class="panel panel-info panel-btn">
<a href="https://help.akeneo.com/pim/serenity/articles/how-to-connect-my-pim-with-apps.html">
<div class="panel-body">
<div>
<img class="pull-left" alt="Go to help center" src="/img/illustrations/illus--apps.svg" style="max-height: 120px; margin-right: 10px;">
</div>
<div>
<h2>Want to know more about App?</h2>
<p>Go to our help center and discover how Akeneo PIM users will connect & manage Apps from the PIM UI</p>
</div>
<div class="panel-custom">
<div class="panel-body">
<div>
<img class="pull-left whats-new-img" alt="Go to help center" src="/img/illustrations/illus--groups.svg">
</div>
</a>
</div>
</div>
<div class="col-xs-12 col-md-6 col-lg-6">
<div class="panel panel-info panel-btn">
<a href="https://apps.akeneo.com/node/add/extension">
<div class="panel-body">
<div>
<img class="pull-left" alt="Go to Akeneo App Store" src="/img/illustrations/illus--marketplace.svg" style="max-height: 120px; margin-right: 10px;">
</div>
<div>
<h2>Your App is good to go?</h2>
<p>Go to the Akeneo App Store and publish it</p>
</div>
<div>
<h2 class="panel-title">What's new?</h2>
<p class="feature-check-out">Check out our new feature : <a class="github-link" href="https://github.com/akeneo/dataset-app">dataset-app for App testing</a></p>
<p class="feature-description">You developed your App and want to test it against high PIM volumetry? Clone our dataset-app repository!</p>
</div>
</a>
</div>
</div>
</div>
</div>
Expand Down
75 changes: 42 additions & 33 deletions src/partials/apps-developer-tools.handlebars
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,51 @@
<div class="row developer-tools">
{{{mainContent}}}
<div class="col-xs-12 col-sm-offset-1 col-sm-8">
<div class="tile-app">
<div class="tile-app-title">
{{startApp.title}}
{{#if startApp.badge_name}}
<span class="tile-app-bagde">{{startApp.badge_name}}</span>
{{/if}}
{{#if startApp.badge_image}}
<span class="tile-app-title-image">
<img class="dev-tools-image"
src="../content/img/{{startApp.badge_image}}"
alt=""/>
</span>
{{/if}}
</div>
<div class="tile-app-content">
{{startApp.content}}
</div>
{{#if startApp.image}}
<div class="tile-app-image">
<img class="dev-tools-image" src="../../img/{{startApp.image}}" alt=""/>
</div>
{{/if}}
<div class="tile-app-list">
{{#each sampleApps}}
<div class="sample-apps">
<a class="anchor" id="{{anchor}}"></a>
<h2 class="sample-app-title" title-id="{{anchor}}"><a class="markdownIt-Anchor" href="#{{anchor}}">#</a>{{section}}</h2>
<div class="tile-app">
<div class="tile-app-title">
{{title}}
{{#if badge_name}}
<span class="tile-app-bagde">{{badge_name}}</span>
{{/if}}
{{#if badge_image}}
<span class="tile-app-title-image">
<img class="dev-tools-image"
src="../content/img/{{badge_image}}"
alt=""/>
</span>
{{/if}}
</div>
<div class="tile-app-content">
{{content}}
</div>
{{#if image}}
<div class="tile-app-image">
<img class="dev-tools-image" src="../../img/{{image}}" alt=""/>
</div>
{{/if}}

{{#each startApp.rows}}
<div class="tile-app-row">
<img class="tile-app-row-image" src="../../img/{{image}}" alt=""/>
{{#if link}}
<div>{{content}}&nbsp;{{#if breakline}}<br/>{{/if}}<a
href="{{link}}" target="_blank" {{#if download}}download{{/if}}>{{link_content}}</a></div>
{{/if}}
{{#each rows}}
<div class="tile-app-row">
<img class="tile-app-row-image" src="../../img/{{image}}" alt=""/>
{{#if link}}
<div>{{content}}&nbsp;{{#if breakline}}<br/>{{/if}}<a
href="{{link}}" target="_blank" {{#if download}}download{{/if}}>{{link_content}}</a></div>
{{/if}}
</div>
{{/each}}
<div class="tile-app-author">{{author}}</div>
</div>
</div>
{{/each}}
<div class="tile-app-author">{{startApp.author}}</div>
{{/each}}
</div>

<a class="anchor" id="api-tools"></a>
<h2 title-id="api-tools"><a class="markdownIt-Anchor" href="#api-tools">#</a>API tools</h2>
<h2 title-id="api-tools"><a class="markdownIt-Anchor" href="#api-tools">#</a>Ease API access</h2>
<div class="tile-app-list">
{{#each apiTools}}
<div class="tile-app">
Expand Down Expand Up @@ -87,7 +96,7 @@

<a class="anchor" id="diving-into-an-app"></a>
<h2 title-id="diving-into-an-app">
<a class="markdownIt-Anchor" href="#diving-into-an-app">#</a>Diving into an App
<a class="markdownIt-Anchor" href="#diving-into-an-app">#</a>Dive into an App
</h2>
<div class="tile-app">
<div class="tile-app-title">
Expand Down
6 changes: 6 additions & 0 deletions styles/apps-developer-tools.less
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,12 @@
width: 816px;
}

.tile-app-list {
.sample-apps {
display: inline;
}
}

.slack-community-content {
margin-top: 30px;
img {
Expand Down
4 changes: 4 additions & 0 deletions styles/apps-homepage.less
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,3 +208,7 @@
margin-top: 16px;
}
}

#dev-tools-btn {
margin-left: 5%;
}
60 changes: 60 additions & 0 deletions styles/panel.less
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,3 +145,63 @@ hr.big {
.skew(0, 3deg);
border-top-width: 40px;
}

.panel-title {
color: #414D97;
font-family: 'Lato';
font-style: italic;
font-weight: 700;
font-size: 26px;
line-height: 31px;
display: flex;

margin-top: 12px;
margin-bottom: 15px;
}

.panel-custom {
box-sizing: border-box;

width: 1026px;
height: 150px;
left: 210px;
top: 678px;

background: #FFFFFF;

border: 1px solid #4CA8E0;
border-radius: 10px;

.panel-body {
padding: 8px;
}
}

.feature-check-out {
font-family: 'Lato';
font-style: normal;
font-weight: 400;
font-size: 19px;
line-height: 23px;
}

.github-link {
color: #414D97;
font-style: italic;
font-weight: 500;
}

.feature-description {
font-family: 'Lato';
font-style: normal;
font-weight: 400;
font-size: 16px;
line-height: 19px;
}

.whats-new-img {
max-width: 136px;
max-height: 136px;
margin-right: 50px;
margin-left: 40px;
}
55 changes: 38 additions & 17 deletions tasks/build-doc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,22 +675,43 @@ gulp.task('build-app-developer-tools', ['clean-dist','less'], function () {
'create-custom-app.md': 'Custom apps'
};

const startApp = {
'title': 'Start Apps',
'badge_name' : 'New',
'content': 'Starter for bootstraping your first Akeneo App quickly.',
'image': 'apps/dev-tools-langages.svg',
'rows': [
{
'image': 'icons/icon--github.png',
'content': 'Github repository:',
'breakline': true,
'link': 'https://github.com/akeneo/sample-apps',
'link_content': 'akeneo/sample-apps',
}
],
'author': 'By Akeneo'
};
const sampleApps = [
{
'anchor': 'sample-apps',
'section': 'Start with Sample Apps',
'title': 'Start Apps',
'content': 'Starter for bootstraping your first Akeneo App quickly.',
'image': 'apps/dev-tools-langages.svg',
'rows': [
{
'image': 'icons/icon--github.png',
'content': 'Github repository:',
'breakline': true,
'link': 'https://github.com/akeneo/sample-apps',
'link_content': 'akeneo/sample-apps',
}
],
'author': 'By Akeneo'
},
{
'anchor': 'dataset-app',
'section': 'Test your App',
'title': 'Dataset App',
'badge_name' : 'New',
'content': 'Automate the integration of large volumes of PIM data to test your App scalability and performance.',
'image': 'apps/dev-tools-php.svg',
'rows': [
{
'image': 'icons/icon--github.png',
'content': 'Github repository:',
'breakline': true,
'link': 'https://github.com/akeneo/dataset-app',
'link_content': 'akeneo/dataset-app',
}
],
'author': 'By Akeneo'
}
];

const apiTools = [
{
Expand Down Expand Up @@ -767,7 +788,7 @@ gulp.task('build-app-developer-tools', ['clean-dist','less'], function () {
return gulp.src('src/partials/apps-developer-tools.handlebars')
.pipe(gulpHandlebars({
active_apps: true,
startApp : startApp,
sampleApps : sampleApps,
apiTools : apiTools,
app : app,
mainContent: fs.readFileSync('tmp/apps/' + path.basename(file.path).replace(/\.md/, '.html')),
Expand Down