Skip to content

Commit 0704d2d

Browse files
Gonchik TsymzhitovGonchik Tsymzhitov
authored andcommitted
Update docs
1 parent ef46389 commit 0704d2d

3 files changed

Lines changed: 63 additions & 22 deletions

File tree

CONTRIBUTING.rst

Lines changed: 48 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,20 @@ the main package repository.
88
Getting Started
99
---------------
1010

11-
1. Fork the repository on GitHub:
12-
https://github.com/atlassian-api/atlassian-python-api
13-
2. Make changes
14-
3. Send pull request
11+
* Fork_ repository
12+
* Keep it sync_'ed while you are developing
13+
* Install pyenv_
14+
* Install related atlassian product for testing through SDK_
15+
* pip install -r requirements.txt
16+
* Start up related product
17+
- atlas-run-standalone_
18+
* Send pull request
19+
20+
.. _Fork: https://help.github.com/articles/fork-a-repo/
21+
.. _sync: https://help.github.com/articles/syncing-a-fork/
22+
.. _pyenv: https://amaral.northwestern.edu/resources/guides/pyenv-tutorial
23+
.. _SDK: https://developer.atlassian.com/server/framework/atlassian-sdk/downloads/
24+
.. _atlas-run-standalone: https://developer.atlassian.com/server/framework/atlassian-sdk/atlas-run-standalone/
1525

1626
Mandatory conditions
1727
--------------------
@@ -45,28 +55,45 @@ References
4555

4656
All methods based on docs from: https://developer.atlassian.com/docs/
4757

48-
1. Jira:
49-
- https://docs.atlassian.com/software/jira/docs/api/REST/latest
50-
2. Confluence:
51-
- https://developer.atlassian.com/server/confluence/confluence-server-rest-api/
52-
3. Jira Service Desk:
53-
- https://developer.atlassian.com/cloud/jira/service-desk/rest/
54-
- https://docs.atlassian.com/jira-servicedesk/REST/server
55-
4. Portfolio for Jira:
56-
- https://docs.atlassian.com/portfolio-for-jira-server/REST/2.13.0/teams/
57-
- https://docs.atlassian.com/portfolio-for-jira-server/REST/2.13.0/jpo/
58-
5. Bitbucket:
58+
* `Jira Server`_
59+
* Confluence_
60+
* `Jira Service Desk Server`_
61+
* `Jira Service Desk Cloud`_
62+
* `Portfolio for Jira`_
63+
* `Portfolio for Jira Teams`_
64+
* Bitbucket:
5965
- https://developer.atlassian.com/server/bitbucket/reference/rest-api/
6066
- https://developer.atlassian.com/server/bitbucket/how-tos/command-line-rest/
61-
6. Bamboo:
67+
* Bamboo:
6268
- https://docs.atlassian.com/atlassian-bamboo/REST/latest/
63-
7. Tempo:
69+
* Tempo:
6470
- https://www.tempo.io/server-api-documentation
6571
- http://tempo.io/doc/core/api/rest/latest/
66-
8. Marketplace:
72+
* Marketplace:
6773
- https://developer.atlassian.com/platform/marketplace/rest
68-
9. Crowd:
74+
* Crowd:
6975
- https://developer.atlassian.com/server/crowd/crowd-rest-apis/
70-
10. Others:
76+
* Others:
7177
- https://developer.atlassian.com/server/jira/platform/oauth/
72-
- https://confluence.atlassian.com/cloud/api-tokens-938839638.html
78+
- https://confluence.atlassian.com/cloud/api-tokens-938839638.html
79+
80+
.. _`Jira Server`: https://docs.atlassian.com/software/jira/docs/api/REST/latest
81+
.. _Confluence: https://developer.atlassian.com/server/confluence/confluence-server-rest-api/
82+
.. _`Jira Service Desk Cloud`: https://developer.atlassian.com/cloud/jira/service-desk/rest/
83+
.. _`Jira Service Desk Server`: https://docs.atlassian.com/jira-servicedesk/REST/server
84+
.. _`Portfolio for Jira Teams`: https://docs.atlassian.com/portfolio-for-jira-server/REST/2.13.0/teams/
85+
.. _`Portfolio for Jira`: https://docs.atlassian.com/portfolio-for-jira-server/REST/2.13.0/jpo/
86+
87+
88+
Credits
89+
-------
90+
In addition to all the contributors we would like to thank to these companies:
91+
92+
* Atlassian_ for developing such a powerful ecosystem.
93+
* JetBrains_ for providing us with free licenses of PyCharm_
94+
* Travis_ for hosting our continuous integration
95+
96+
.. _Atlassian: https://www.atlassian.com/
97+
.. _JetBrains: http://www.jetbrains.com
98+
.. _PyCharm: http://www.jetbrains.com/pycharm/
99+
.. _Travis: https://travis-ci.org/

README.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,3 +109,17 @@ See the `Contribution guidelines for this project`_ for details on how to make c
109109
:alt: Codacy Badge
110110
.. |PyPI - Downloads| image:: https://img.shields.io/pypi/dm/atlassian-python-api.svg
111111
:alt: PyPI - Downloads
112+
113+
114+
Credits
115+
-------
116+
In addition to all the contributors we would like to thank to these companies:
117+
118+
* Atlassian_ for developing such a powerful ecosystem.
119+
* JetBrains_ for providing us with free licenses of PyCharm_
120+
* Travis_ for hosting our continuous integration
121+
122+
.. _Atlassian: https://www.atlassian.com/
123+
.. _JetBrains: http://www.jetbrains.com
124+
.. _PyCharm: http://www.jetbrains.com/pycharm/
125+
.. _Travis: https://travis-ci.org/

atlassian/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.13.12
1+
1.13.13

0 commit comments

Comments
 (0)