inteligr8/alfresco-content-app
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-content-app.git synced 2025-05-12 17:04:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs update (#124)

Browse Source 
* docs: contribution policy

* 'Where to get help' section

* update docs
This commit is contained in:
Denys Vuika 2017-12-08 12:23:56 +00:00 committed by Cilibiu Bogdan
parent 2f33eafdc4
commit b97f86340e
1 changed files with 92 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
docs/README.md
View File

@ -1,9 +1,75 @@
# Alfresco Content App
# Alfresco Example Content Application
## Prerequisites
## Introduction
- Alfresco Content Services (Community) or Alfresco Content Services 5.2.2 (Enterprise)
- [node.js](https://nodejs.org/en/) 8.9.1 or later
The Alfresco Content Application is an example application built using
[Alfresco Application Development Framework (ADF)](https://github.com/Alfresco/alfresco-ng2-components) components.
### Who is this example application for
This example application demonstrates to Angular software engineers
how to construct a content application using the Alfresco ADF.
This example application represents a meaningful composition of ADF components that provide end users
with a simple and easy to use interface for working with files stored in the Alfresco Content Services repository.
### Prerequisites
This application utilises the latest releases from Alfresco:
- [Alfresco ADF version 2.0](https://community.alfresco.com/community/application-development-framework/pages/get-started)
- [Alfresco Content Services version 5.2.2](https://www.alfresco.com/platform/content-services-ecm)
- [Alfresco Community Edition 201707](https://www.alfresco.com/products/community/download)
<p class="warning">
You also need [node.js](https://nodejs.org/en/) (8.9.1 or later) installed to build it locally from source code.
</p>
The latest version of the Alfresco Content platform is required
due to the application utilising the latest [REST APIs](https://docs.alfresco.com/5.2/pra/1/topics/pra-welcome.html) developments.
## Where to get help
There are a number of ways to get help with building applications using the Alfresco Application Development Framework:
### Alfresco DevCon 2018
DevCon 2018 is an international developer conference entirely dedicated to Alfresco technology.
With the support of our community, customers, and partners, DevCon will increase your technical know-how,
connect you with other Alfresco developers, and let you collaborate with our team and each other.
Register now to avoid disappointment, places are limited:
http://devcon.alfresco.com/
### Alfresco Community
Visit the Alfresco Community space where you can find many resources to help you get started building your application,
along with blog posts from the Alfresco developers and much more:
https://community.alfresco.com/community/application-development-framework
### Alfresco ADF Gitter
Join the vibrant community in Gitter where you can chat with experienced developers,
including the Alfresco employees working directly on the ADF and this example application project:
https://gitter.im/Alfresco/alfresco-ng2-components
### Alfresco Developer Support
Developer Support is a subscription-based support offering delivered remotely
by a dedicated team of development-focused, senior Support Engineers.
This support offering is best for customers and partners that require on-going support
for their development teams and customized code.
Visit the Developer Support Services section on the Alfresco website for more information:
https://www.alfresco.com/alfresco-developer-support-services
### Alfresco University
Training with Alfresco University is the best way to acquire the right skills for your team to deliver a successful Alfresco implementation.
The most cost-effective way to take advantage of this valuable training is through Alfresco University Passport.
Visit the Alfresco University section on the Alfresco website for more information:
https://www.alfresco.com/alfresco-university
## Building and running locally
@ -13,3 +79,25 @@ Please refer to the [developer docs](/build) to get more details on building and
The Content App provides a "Dockerfile" and "docker-compose" files to aid in running application in a container.
Please refer to the "[Using with Docker](/docker)" article for more details.
## Contribution Policy
### How to contribute
Fork our repository and submit a pull request when your code is ready for review.
To be considered the Travis build has to be green and all our automation tests have to run without regressions.
### Contribute to the existing code base
What are we reviewing for?
- **License**: Every file should contain the Alfresco LICENSE header, LGPL Licence.
- **Tests**: Add unit cases to cover the new behaviour, and make sure all the existing tests are still green.
- **JS Documentation**: Every class needs to have its own inline jsdoc, this documentation should explain the general purpose of the class and of each method.
- **Documentation**: Update the documentation explaining how to use the new functionality, may not be necessary in the cases where change impacts only the CSS style.
- **Clean Coding**: Some good rules are enforced by the tslint, but we want also our code to be easy to read. Please avoid comments inside the code or leaving pieces of code commented out.
- **Localization**: Your contribution needs to support localization, with all new strings externalized, all translations are inside the i18n. The minimum requirement is English.
### How long will it take for my contribution to be reviewed?
The time necessary for a code review will vary, smaller changes may be reviewed within days, while larger changes may take longer.