-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ab65da6
commit 805655d
Showing
694 changed files
with
105,828 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
nodeLinker: node-modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,34 @@ | ||
# docusaurus-hyperse | ||
The hyperse-io documents, blogs website | ||
# Website | ||
|
||
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. | ||
https://gitlab.com/aweframework/awe/-/tree/develop/website | ||
|
||
### Installation | ||
|
||
``` | ||
$ yarn | ||
``` | ||
|
||
### Local Development | ||
|
||
``` | ||
$ yarn start | ||
``` | ||
|
||
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. | ||
|
||
### Build | ||
|
||
``` | ||
$ yarn build | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
||
### Deployment | ||
|
||
``` | ||
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy | ||
``` | ||
|
||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
module.exports = { | ||
presets: [require.resolve('@docusaurus/core/lib/babel/preset')], | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
title: Welcome to AWE Blog | ||
author: Pablo Vidal | ||
author_title: Senior Software Engineer @ Almis | ||
author_url: https://gitlab.com/Limkin | ||
author_image_url: https://gitlab.com/uploads/-/system/user/avatar/3234812/avatar.png?width=400 | ||
tags: [awe, hola] | ||
--- | ||
|
||
<img style={{ width: "50%", margin: "10% 25%", padding: "50" }} | ||
alt="Awe Logo" | ||
src={require('@docusaurus/useBaseUrl').default('img/logo.svg')} | ||
/> | ||
|
||
From `AWE` team we want to welcome you and open this new communication channel to everyone. | ||
|
||
We will publish `AWE framework` news as well as tutorials and other interesting things related to web application development. | ||
|
||
So, **welcome aboard!** :smile: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: Notification module | ||
author: Pablo García | ||
author_title: Senior Software Engineer @ Almis | ||
author_url: https://gitlab.com/pablo.garcia.almis | ||
author_image_url: https://gitlab.com/uploads/-/system/user/avatar/3234791/avatar.png?width=400 | ||
tags: [awe, notificación, subscripción, novedad] | ||
--- | ||
|
||
<img style={{ width: "60%", margin: "10% 20%" }} | ||
alt="AWE security" | ||
src={require('@docusaurus/useBaseUrl').default('img/undraw_notifications.svg')} | ||
/> | ||
|
||
`AWE Framework` now has a new _module_: **Notification module**. | ||
|
||
This module allows _very easily_ to create new topics and publish notifications over them. | ||
|
||
We also have developed a new `settings` screen to allow the user to subscribe to topics which he or she prefers via **notification** or **email**. | ||
|
||
To see more information about this new functionality, you can read about it on [this link](/docs/guides/notifier) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: Two-factor authentication | ||
author: Pablo García | ||
author_title: Senior Software Engineer @ Almis | ||
author_url: https://gitlab.com/pablo.garcia.almis | ||
author_image_url: https://gitlab.com/uploads/-/system/user/avatar/3234791/avatar.png?width=400 | ||
tags: [awe, 2fa, seguridad, novedad] | ||
--- | ||
|
||
<img style={{ width: "60%", margin: "10% 20%", padding: "50" }} | ||
alt="TOTP Code" | ||
src={require('@docusaurus/useBaseUrl').default('img/totp-code.png')} | ||
/> | ||
|
||
We have added a new security function to our framework: **Two-factor authentication**. | ||
|
||
This development adds the possibility to enable an extra authentication factor based on apps like **Google Authenticator** to | ||
enter the application. We have also added the possibility to force all the users to activate this second factor to improve | ||
access security. | ||
|
||
To see more information about this new functionality, you can read about it on [this link](/docs/security#two-factor-authentication-2fa) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: AWE get Spring Boot 3 | ||
author: Pablo Vidal | ||
author_title: Senior Software Engineer @ Almis | ||
author_url: https://gitlab.com/limkin | ||
author_image_url: https://gitlab.com/uploads/-/system/user/avatar/3234812/avatar.png?width=400 | ||
tags: [awe, spring, spring boot 3, novedad] | ||
--- | ||
|
||
<img style={{ width: "60%", margin: "10% 20%", padding: "50" }} | ||
alt="Spring Boot 3" | ||
src={require('@docusaurus/useBaseUrl').default('img/blog/spring-boot-3.png')} | ||
/> | ||
|
||
The AWE framework team is pleased to announce that starting with version 4.7.1, | ||
AWE will use the Spring Boot 3 and Spring 6 version as a base image. | ||
In this way, we will be prepared for new functionalities, greater security and of course, better maintenance. | ||
|
||
This version requires us to use **Java 17**, so you have to take this into account if you want to use the new version of AWE. | ||
|
||
To see more information about the new features of Spring Boot 3, you can see it on [this link](https://www.baeldung.com/spring-boot-3-spring-6-new). | ||
|
||
Next, we leave you the [migration guide](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-3.0-Migration-Guide) for AWE applications that use the new version of Spring Boot 3. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# | ||
# Crowding configuration | ||
# | ||
project_id_env: CROWDIN_PROJECT_ID | ||
api_token_env: CROWDIN_PERSONAL_TOKEN | ||
preserve_hierarchy: true | ||
|
||
# | ||
# Files configuration | ||
# | ||
files: [ | ||
# JSON translation files | ||
{ | ||
source: '/i18n/en/**/*', | ||
translation: '/i18n/%two_letters_code%/**/%original_file_name%', | ||
}, | ||
# Docs (Current) Markdown files | ||
{ | ||
source: '/docs/**/*', | ||
translation: '/i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%', | ||
}, | ||
# Docs (Versioned) Markdown files | ||
{ | ||
source: '/versioned_docs/**/*', | ||
translation: '/i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name%', | ||
}, | ||
# Blog Markdown files | ||
{ | ||
source: '/blog/**/*', | ||
translation: '/i18n/%two_letters_code%/docusaurus-plugin-content-blog/**/%original_file_name%', | ||
}, | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
id: annotations | ||
title: Annotations Module | ||
sidebar_label: Annotations Module | ||
--- | ||
|
||
The `annotations` module includes a set of Spring-oriented annotations to make it easier to manage some AWE features. | ||
|
||
To include this module, just add the dependency to the pom descriptor: | ||
|
||
```xml | ||
<dependencies> | ||
... | ||
<dependency> | ||
<groupId>com.almis.awe</groupId> | ||
<artifactId>awe-annotations-spring-boot-starter</artifactId> | ||
</dependency> | ||
... | ||
</dependencies> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
--- | ||
id: accordion | ||
title: Accordion | ||
--- | ||
|
||
An accordion is a layout component that allows to organize the content in different sections that can be collapsed or expanded. Inside its panels, it allows to have the same content as a window or a tag element, even nested accordions. | ||
|
||
<img alt="Accordion" src={require('@docusaurus/useBaseUrl').default('img/accordion4.png')} /> | ||
|
||
## XML skeleton | ||
|
||
```xml | ||
<accordion id="[accordion-identifier]" ...> | ||
<accordion-item... /> | ||
<dependency... /> | ||
</accordion> | ||
``` | ||
|
||
## Accordion structure | ||
|
||
```xml | ||
<accordion id="[accordion-identifier]" selected="[id-selected]" autocollapse="[accordion-autocollapse]" style="[accordion-style]"> | ||
... | ||
</accordion> | ||
``` | ||
|
||
## Accordion attributes | ||
|
||
| Attribute | Use | Type | Description | Values | | ||
| ----------- | ------------ |-----------|-----------------------------|----------------------------------------------------| | ||
| id | **Required** | String | Accordion identifier. For reference purposes | | | ||
| autocollapse | Optional | String | If set to "true" only one accordion item can stay opened at a time | `true` or `false` (default is `true`) | | ||
| selected | Optional | String | If we want an accordion item to be opened at the beginning, set its ID here | | | ||
| style | Optional | String | Grid CSS classes | We can use `panel-group-[type]` and `panel-group-dark` classes to style (type can be the usual `danger`, `success`, etc. values) | | ||
|
||
## Accordion Item structure | ||
|
||
```xml | ||
<accordion-item id="[accordion-item-identifier]" label="[accordion-item-label]" | ||
style="[accordion-item-style]"> | ||
... | ||
</accordion-item> | ||
``` | ||
|
||
## Accordion Item attributes | ||
|
||
| Attribute | Use | Type | Description | Values | | ||
| ----------- | ------------ |-----------|-----------------------------|----------------------------------------------------| | ||
| id | **Required** | String | Accordion item identifier. For reference purposes | | | ||
| label | **Required** | String | Text to be placed inside of the header | **Note:** You can use [i18n](i18n-internationalization.md) files (locales) | | ||
| style | Optional | String | Grid CSS classes | | | ||
|
||
## Dependencies | ||
|
||
If we want to collapse or expand an accordion item using a dependency, we must use one that modifies the attribute `selected` setting the ID of the item (if it's expanded it will collapse and viceversa) | ||
|
||
```xml | ||
<dependency target-type="attribute" target-action="selected" value="[child-id]"> | ||
... | ||
</dependency> | ||
``` | ||
|
||
## Examples | ||
|
||
Below we can see the difference between having the *autocollapse* attribute as `true` (left) or `false` (right) | ||
|
||
<img alt="Accordion example 1" src={require('@docusaurus/useBaseUrl').default('img/accordion.png')} /> | ||
|
||
Below an accordion item holding a window with an include | ||
|
||
<img alt="Accordion example 2" src={require('@docusaurus/useBaseUrl').default('img/accordion3.png')} /> | ||
|
||
And this would be a full accordion structure example | ||
```xml | ||
<accordion id="acc2" autocollapse="false" style="panel-group-info"> | ||
<accordion-item id="acc2-1" label="Item 1"> | ||
<tag> | ||
<text> | ||
"Lorem ipsum ... laborum." | ||
</text> | ||
</tag> | ||
</accordion-item> | ||
<accordion-item id="acc2-2" label="Item 2"> | ||
<tag> | ||
<text> | ||
"Sed ut ... pariatur?" | ||
</text> | ||
</tag> | ||
</accordion-item> | ||
<accordion-item id="acc2-3" label="Item 3"> | ||
<tag> | ||
<text> | ||
"At vero ... repellat." | ||
</text> | ||
</tag> | ||
</accordion-item> | ||
</accordion> | ||
``` | ||
|
Oops, something went wrong.