Skip to content
This repository was archived by the owner on Aug 1, 2021. It is now read-only.

Commit ffd0c46

Browse files
brunobritodevbrunobritodev
committed
update docs
1 parent 242a8ec commit ffd0c46

4 files changed

Lines changed: 145 additions & 9 deletions

File tree

‎docs/index.rst‎

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Helping teams and entrepreneurs to achieve the company's primary purpose: Maximi
1616

1717
Now we are online! `See it in action <https://jpproject.azurewebsites.net/admin-ui>`_
1818

19-
There is a intro video too!
19+
There is an intro video too!
2020

2121
.. raw:: html
2222

@@ -32,6 +32,44 @@ Do you love it? give us a :yellow:`Star!` ⭐
3232
.. raw:: html
3333

3434
<iframe src="https://ghbtns.com/github-btn.html?user=brunohbrito&repo=JP-Project&type=star&size=large" frameborder="0" scrolling="0" width="160px" height="30px"></iframe>
35+
<br>
36+
37+
38+
Features 🏷️
39+
-----------
40+
41+
The complete solution are composed by:
42+
43+
- IdentityServer4 UI. Made with ASP.NET Core MVC. Indeed it's based in `QuickstartUI <https://github.com/IdentityServer/IdentityServer4.Quickstart.UI>`_ with few modifications for separation of concern.
44+
- A RESTful API to expose their features. It's integrated with Swagger.
45+
- Administration Panel UI for IdentityServer4 and users. Users are using ASP.NET Core Identity.
46+
- User self Management UI. Panel for user to change his profile. He can also create, change or recover a password.
47+
48+
49+
Docker
50+
^^^^^^^
51+
52+
Entire solution is available on docker. Easy as: `docker-compose up` and go to http://localhost:5000.
53+
54+
Azure DevOps
55+
^^^^^^^^^^^^
56+
57+
If you plan to extend it for your own needs it has yaml for Continuous integration and other file with Artifacts for Continuous Delivery with Azure DevOps.
58+
59+
60+
Translations
61+
^^^^^^^^^^^^
62+
63+
It's available for several languages. Most of them was auto generated by **Google Translation**.
64+
65+
- English
66+
- Portuguese (pt-BR) *auto translated*
67+
- Spanish (es) *auto translated*
68+
- French (fr) *auto translated*
69+
- Dutch (nl) *auto translated*
70+
- Russian (ru) *auto translated*
71+
- Chinese simplified (zh-CN) *auto translated*
72+
- Chinese traditional (zh-TW) *auto translated*
3573

3674

3775
Contributing
@@ -59,7 +97,7 @@ There are several ways we can help you out.
5997
intro/architecture
6098
intro/contributing
6199
intro/code_of_conduct
62-
intro/contributors.md
100+
intro/contributors
63101

64102
.. toctree::
65103
:maxdepth: 2

‎docs/intro/code_of_conduct.rst‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,18 @@ threatening, offensive, or harmful.
5050
Scope
5151
-----
5252

53-
This Code of Conduct applies both within project spaces and in public spaces
54-
when an individual is representing the project or its community. Examples of
55-
representing a project or community include using an official project e-mail
56-
address, posting via an official social media account, or acting as an appointed
57-
representative at an online or offline event. Representation of a project may be
58-
further defined and clarified by project maintainers.
53+
This Code of Conduct applies within all project spaces, and it also applies when
54+
an individual is representing the project or its community in public spaces.
55+
Examples of representing a project or community include using an official
56+
project e-mail address, posting via an official social media account, or acting
57+
as an appointed representative at an online or offline event. Representation of
58+
a project may be further defined and clarified by project maintainers.
5959

6060
Enforcement
6161
-----------
6262

6363
Instances of abusive, harassing, or otherwise unacceptable behavior may be
64-
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
64+
reported by contacting the project team at bhdebrito@gmail.com. All
6565
complaints will be reviewed and investigated and will result in a response that
6666
is deemed necessary and appropriate to the circumstances. The project team is
6767
obligated to maintain confidentiality with regard to the reporter of an incident.

‎docs/intro/code_of_conduct.rst.bak‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
Contributor Covenant Code of Conduct
2+
====================================
3+
4+
Our Pledge
5+
----------
6+
7+
In the interest of fostering an open and welcoming environment, we as
8+
contributors and maintainers pledge to making participation in our project and
9+
our community a harassment-free experience for everyone, regardless of age, body
10+
size, disability, ethnicity, sex characteristics, gender identity and expression,
11+
level of experience, education, socio-economic status, nationality, personal
12+
appearance, race, religion, or sexual identity and orientation.
13+
14+
Our Standards
15+
-------------
16+
17+
Examples of behavior that contributes to creating a positive environment
18+
include:
19+
20+
* Using welcoming and inclusive language
21+
* Being respectful of differing viewpoints and experiences
22+
* Gracefully accepting constructive criticism
23+
* Focusing on what is best for the community
24+
* Showing empathy towards other community members
25+
26+
Examples of unacceptable behavior by participants include:
27+
28+
* The use of sexualized language or imagery and unwelcome sexual attention or
29+
advances
30+
* Trolling, insulting/derogatory comments, and personal or political attacks
31+
* Public or private harassment
32+
* Publishing others' private information, such as a physical or electronic
33+
address, without explicit permission
34+
* Other conduct which could reasonably be considered inappropriate in a
35+
professional setting
36+
37+
Our Responsibilities
38+
--------------------
39+
40+
Project maintainers are responsible for clarifying the standards of acceptable
41+
behavior and are expected to take appropriate and fair corrective action in
42+
response to any instances of unacceptable behavior.
43+
44+
Project maintainers have the right and responsibility to remove, edit, or
45+
reject comments, commits, code, wiki edits, issues, and other contributions
46+
that are not aligned to this Code of Conduct, or to ban temporarily or
47+
permanently any contributor for other behaviors that they deem inappropriate,
48+
threatening, offensive, or harmful.
49+
50+
Scope
51+
-----
52+
53+
This Code of Conduct applies both within project spaces and in public spaces
54+
when an individual is representing the project or its community. Examples of
55+
representing a project or community include using an official project e-mail
56+
address, posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event. Representation of a project may be
58+
further defined and clarified by project maintainers.
59+
60+
Enforcement
61+
-----------
62+
63+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
64+
reported by contacting the project team at bhdebrito@gmail.com. All
65+
complaints will be reviewed and investigated and will result in a response that
66+
is deemed necessary and appropriate to the circumstances. The project team is
67+
obligated to maintain confidentiality with regard to the reporter of an incident.
68+
Further details of specific enforcement policies may be posted separately.
69+
70+
Project maintainers who do not follow or enforce the Code of Conduct in good
71+
faith may face temporary or permanent repercussions as determined by other
72+
members of the project's leadership.
73+
74+
Attribution
75+
-----------
76+
77+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
78+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
79+
80+
`homepage <https://www.contributor-covenant.org>`_

‎docs/intro/contributors.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Contributors
2+
=============
3+
4+
Below our lovely Contributors!
5+
6+
+------------------+
7+
| Contributors |
8+
+==================+
9+
| |brunobrito| |
10+
| |
11+
| Bruno Brito💓 |
12+
| |
13+
| `🌍 Site`__ |
14+
+------------------+
15+
16+
.. |brunobrito| image:: https://avatars3.githubusercontent.com/u/7241156?v=4&s=460
17+
:width: 118 px
18+
__ https://www.brunobrito.net.br/

0 commit comments

Comments
 (0)