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

Update doc about TWA #467

Merged
merged 9 commits into from Mar 9, 2017
Merged

Update doc about TWA #467

merged 9 commits into from Mar 9, 2017

Conversation

willy-ahva
Copy link
Contributor

@willy-ahva willy-ahva commented Jan 27, 2017

Re organize menu and pages.

________

With the Activity Manager feature comes a widget in the dashboard. The goal of this widget is to display the
completeness for contributors and owner. Displayed data are contextual. That means that the completeness is not the same
Copy link
Contributor

Choose a reason for hiding this comment

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

It means the completeness ?

Copy link
Contributor

@grena grena left a comment

Choose a reason for hiding this comment

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

Small comments, then GTM

________

With the Activity Manager feature comes a widget in the dashboard. The goal of this widget is to display the
completeness for contributors and owner. Displayed data are contextual. That means that the completeness is not the same
Copy link
Contributor

Choose a reason for hiding this comment

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

It means


With the Activity Manager feature comes a widget in the dashboard. The goal of this widget is to display the
completeness for contributors and owner. Displayed data are contextual. That means that the completeness is not the same
for each contributor and for the owner. Contributor sees completeness in terms of their own permissions. The owner sees
Copy link
Contributor

Choose a reason for hiding this comment

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

Contibutors see (...)

With the Activity Manager feature comes a widget in the dashboard. The goal of this widget is to display the
completeness for contributors and owner. Displayed data are contextual. That means that the completeness is not the same
for each contributor and for the owner. Contributor sees completeness in terms of their own permissions. The owner sees
the completeness of all the project perimeter.
Copy link
Contributor

Choose a reason for hiding this comment

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

the real full completeness of family requirements

Or I don't know, but "the completeness of all the project perimeter" is not clear to me :)

# src/PimEnterprise/Bundle/ActivityManagerBundle/Resources/config/form_extensions/widget.yml
extensions:
activity-manager-widget-project-selector:
module: activity-manager/widget/project-selector
Copy link
Contributor

Choose a reason for hiding this comment

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

You can add above this line:

The module of your extension that should be declared in a requirejs.yml file

++++++++++++

Unlike the others, the activity manager widget has been done with the Product Edit Form architecture, so that it is
more customizable and maintainable. That allowed us to create some extension points thanks to target zones.
Copy link
Contributor

Choose a reason for hiding this comment

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

It allowed us .... ?

@willy-ahva willy-ahva changed the base branch from master to 1.7 March 7, 2017 16:21
@willy-ahva willy-ahva changed the title AMS-144: Add AM widget extension points doc Update doc about TWA Mar 9, 2017
Copy link
Contributor

@grena grena left a comment

Choose a reason for hiding this comment

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

Fix then GTM :)

How To Log Memory Usage In Calculation Steps
============================================

We created the
Copy link
Contributor

Choose a reason for hiding this comment

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

IMOH, it could be nice have a kind of short "intro".

  • Why could we have to log memory usage ?
  • What are calculation steps?
  • What will I read in this doc?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@@ -1,8 +1,18 @@
Add A Calculation Step
======================

Before saving a project a job is launched in background. This job is composed by calculation steps. Each calculation step
is used to execute an action between the project and a product. For example, we extract data from the product to add
information in project. For custom development you may need to add your own calculation step.
Copy link
Contributor

Choose a reason for hiding this comment

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

Cool for the intro :)

@@ -5,4 +5,5 @@ How To Customize Teamwork Assistant (Enterprise Edition)

Customize notifications <customize_notification>
Add a calculation step <calculation_step>
How log calculation step <activate_loggable_step>
Copy link
Contributor

Choose a reason for hiding this comment

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

How to*

In the case you extended the Teamwork Assistant, you may want to check that you didn't broke basics features. You can
have a look to the `Setup Behat part`_ to learn more about how to run our functional tests.

Because the Teamwork Assistant heavily uses permissions we created a custom catalog that we use in our test features.
Copy link
Contributor

Choose a reason for hiding this comment

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

(...) heavily uses permissions, we created (...)
(missing comma)

have a look to the `Setup Behat part`_ to learn more about how to run our functional tests.

Because the Teamwork Assistant heavily uses permissions we created a custom catalog that we use in our test features.
Here is summary about permissions we use in our catalog. This catalog has been modified in few scenario but it is still
Copy link
Contributor

Choose a reason for hiding this comment

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

Here is a summary

Project Completeness Format
___________________________

One normalized the completeness looks like this:
Copy link
Contributor

Choose a reason for hiding this comment

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

Once normalized, (...)

completeness per user. Guessing impacted user groups is not a big deal and can be done during project creation to gain
completeness calculation time and scalability.
The advantage is that the regularity of the pre-processing data updating can be adjusted as required with this command.
Before to use this you should have a look to the scalability guide.
Copy link
Contributor

Choose a reason for hiding this comment

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

Before using this

during the night for many projects as we don't pre-process all the catalog but only products concerned by projects.
As it's faster, the regularity of the pre-processing data updating can be adjusted as required.
during the night for many projects as we don't pre-process all the catalog but only products concerned by projects and
products that as been updated.
Copy link
Contributor

Choose a reason for hiding this comment

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

that has been

notify users concerned by the project.

For each product we need to identify the user groups that have the rights to edit the product, once all the products
have been checked we send a notification to the concerned users (aka the contributors).
Copy link
Contributor

Choose a reason for hiding this comment

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

(...) have been checked, we send (...)
(missing comma)


With the Teamwork Assistant feature comes a widget in the dashboard. The goal of this widget is to display the
completeness for contributors and owner. Displayed data are contextual. It means that the completeness is not the same
for each contributor and for the owner. Contributors see completeness in terms of their own permissions. The owner sees
Copy link
Contributor

Choose a reason for hiding this comment

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

Contributors see completeness depending on their own permissions

@willy-ahva willy-ahva merged commit e023b29 into 1.7 Mar 9, 2017
@willy-ahva willy-ahva deleted the AMS-144 branch March 9, 2017 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants