Skip to content

Commit

Permalink
Merge branch 'main' into signing-transactions-offline
Browse files Browse the repository at this point in the history
  • Loading branch information
segfaultxavi authored Nov 9, 2020
2 parents 01dfc1c + 6b3e255 commit c6a473b
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 34 deletions.
36 changes: 18 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@
# Contributing to symbol-docs

First off, thank you for considering contributing to symbol-docs.
First off, thank you for considering contributing to symbol-docs.

The Symbol Documentation is an open-source project, and we love to receive contributions from our community — you!
The Symbol Documentation is an open-source project, and we love to receive contributions from our community — you!

There are many ways to contribute, from writing guides, improving the documentation, submitting errors and requests or
There are many ways to contribute, from writing guides, improving the documentation, submitting errors and requests or
writing new pieces of documentation that can be incorporated into the docs itself.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project.
In return, they should reciprocate that respect in addressing your issue, assessing changes, and help you finalize your pull requests.

## Error reports

If you think you have found an error in the symbol-docs, first make sure that you are testing against the latest version of symbol-docs - your issue may already have been fixed. If not, search our issues list on GitHub in case a similar issue has already been opened.

It is very helpful if you can prepare a reproduction of the error. It makes it easier to find the problem and to fix it.

Please, take into consideration the next template to report your issue:

**Describe the error**
A clear and concise description of what the error is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

Open a new issue [here][github-issues].

## Requests

If you find yourself wishing for content that does not exist in symbol-docs, you are probably not alone.
Most of the documentation and guides that symbol-docs have today have been added because our users saw the need.
Open an [issue][github-issues] on our issues list on GitHub which describes the missing documentation or improvement
If you find yourself wishing for content that does not exist in symbol-docs, you are probably not alone.
Most of the documentation and guides that symbol-docs have today have been added because our users saw the need.
Open an [issue][github-issues] on our issues list on GitHub which describes the missing documentation or improvement
you would like to see.

If the improvement is not related to documentation, but with a specific project, please check CONTRIBUTING.md in the
If the improvement is not related to documentation, but with a specific project, please check CONTRIBUTING.md in the
project repository.

## Contributing code and documentation changes

To expand and improve the symbol-docs, please find or open an issue about it first.
To expand and improve the symbol-docs, please find or open an issue about it first.

Talk about what you would like to do. It may be that somebody is already working on it,
Talk about what you would like to do. It may be that somebody is already working on it,
or that there are particular issues that you should know about before implementing the change.

We enjoy working with contributors to get their pull-requests accepted.
Expand All @@ -68,7 +68,7 @@ Then, install requirements using pip:

`pip install -r requirements.txt`

Run the following command and open the provided url in a browser.
Run the following command and open the provided URL in a browser.

`make livehtml`

Expand All @@ -82,15 +82,15 @@ Once your changes and tests are ready to submit for review:

2. Submit a pull request.

Push your local changes to your forked copy of the repository and [submit a pull request](https://help.github.com/articles/about-pull-requests/). In the pull request, choose a title which sums up the changes that you have made, and in the body provide more details about what your changes do. Also mention the number of the issue where discussion has taken place, eg "Closes #123".
Push your local changes to your forked copy of the repository and [submit a pull request](https://help.github.com/articles/about-pull-requests/). In the pull request, choose a title which sums up the changes that you have made, and in the body provide more details about what your changes do. Also mention the number of the issue where discussion has taken place, e.g. "Closes #123".

Then sit back and wait. There will probably be a discussion about the pull request and, if any changes are needed, we would love to work with you to get your pull request merged into symbol-docs.

### Contributing License Notice

When you contribute code, you affirm that the contribution is your original work and that you license the work to the project under the project's open-source license.

Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's open source license and warrant that you have the legal authority to do so.
Whether you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's open source license and warrant that you have the legal authority to do so.

*CONTRIBUTING.md is based on [CONTRIBUTING-template.md](https://github.com/nayafia/contributing-template/blob/master/CONTRIBUTING-template.md)* , [elasticsearch/CONTRIBUTING](https://github.com/elastic/elasticsearch/blob/master/CONTRIBUTING.md) and [spark/CONTRIBUTING](https://github.com/apache/spark/blob/master/CONTRIBUTING.md)

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Surf Symbol's reference documentation to learn more about our APIs, SDKs, CLIs,
Symbol is an [open-source](https://github.com/nemtech) project.
Discover how our [community](https://github.com/nemtech/community/) is organized, and get started participating:

* Reach our community joining the official [Slack](https://join.slack.com/t/nem2/shared_invite/zt-h0ppnjfm-ood2bVW5P8I2RzcMFgbCVw).
* Reach our community joining the official [Slack](https://join.slack.com/t/nem2/shared_invite/zt-j0xtyrr8-dJ9p0~Lua4lJx9ZoLbq7mg).
* Check the [contributing guidelines](https://docs.symbolplatform.com/guidelines/suggesting-changes.html) to propose changes.
* Follow the development updates on [Twitter](https://twitter.com/NEMofficial).
* Explore our [GitHub](https://github.com/nemtech) repositories.
Expand Down
2 changes: 1 addition & 1 deletion source/_templates/include/social.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<a href="https://twitter.com/NEMofficial" rel="nofollow"><i class="fab fa-twitter"></i></a>
</li>
<li>
<a href="https://join.slack.com/t/nem2/shared_invite/zt-h0ppnjfm-ood2bVW5P8I2RzcMFgbCVw"
<a href="https://join.slack.com/t/nem2/shared_invite/zt-j0xtyrr8-dJ9p0~Lua4lJx9ZoLbq7mg"
rel="nofollow"><i class="fab fa-slack"></i></a>
</li>
<li>
Expand Down
4 changes: 4 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,10 @@ def setup(app):
.. |sdk| replace:: Symbol SDK
.. |cli| replace:: Symbol CLI
.. |desktop-wallet| replace:: Symbol Desktop Wallet
.. |slack| raw:: html
<a href="https://join.slack.com/t/nem2/shared_invite/zt-j0xtyrr8-dJ9p0~Lua4lJx9ZoLbq7mg" target="_blank">Slack</a>
"""

# -- Options for Epub output ----------------------------------------------
Expand Down
4 changes: 0 additions & 4 deletions source/contribute/community.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ Discover how the open source |community| works, and get started participating:

<a href="https://github.com/nemtech/community/" target="_blank">community</a>

.. |slack| raw:: html

<a href="https://join.slack.com/t/nem2/shared_invite/zt-hwsoo1s5-G8XO50LaY0m7ZKTRXAczcA" target="_blank">Slack</a>

.. |twitter| raw:: html

<a href="https://twitter.com/NEMofficial" target="_blank">Twitter</a>
2 changes: 1 addition & 1 deletion source/guidelines/sdk-development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Before starting
2. Setup the |codename| :doc:`local environment via docker <../guides/network/creating-a-private-test-net>`.
3. Check the :doc:`API reference <../api>` and play with offered set of endpoints.
4. Become familiar with the current :doc:`SDK via code examples <../concepts/account>` and :ref:`CLI <wallet-cli>` .
5. Join our `Slack <https://join.slack.com/t/nem2/shared_invite/zt-hwsoo1s5-G8XO50LaY0m7ZKTRXAczcA>`_ to ask |codename| related questions.
5. Join our |slack| to ask |codename| related questions.
6. Be sure no one is already working on the SDK you want to create. Check the :doc:`repository list <../sdk>` and comment on your intentions in ``#sig-api`` channel.
7. Claim the SDK `forking this repository <https://help.github.com/en/articles/creating-a-pull-request/>`_ and add a new entry to the :doc:`repository list <../sdk>`.

Expand Down
2 changes: 1 addition & 1 deletion source/guidelines/writing-a-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Before starting
***************

If you are looking for inspiration to write the guide, you can browse the `symbol-docs repository open issues <https://github.com/nemtech/symbol-docs/issues>`_ to find some ideas pending to be written.
We also encourage you to join our `Slack <https://join.slack.com/t/nem2/shared_invite/zt-hwsoo1s5-G8XO50LaY0m7ZKTRXAczcA>`_ #sig-docs channel and present yourself!
We also encourage you to join our |slack| #sig-docs channel and present yourself!

To collaborate with one of the existing issues, express it in a comment to avoid duplicated efforts.
If there is no issue yet, create a new one introducing the content you want to publish.
Expand Down
4 changes: 0 additions & 4 deletions source/guides/migration/migrating-from-nem-to-symbol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -221,10 +221,6 @@ We invite you to connect with our developer community by joining the |slack|.

<a href="https://stackoverflow.com/tags/nem/" target="_blank">StackOverflow</a>

.. |slack| raw:: html

<a href="https://join.slack.com/t/nem2/shared_invite/zt-hwsoo1s5-G8XO50LaY0m7ZKTRXAczcA" target="_blank">Slack</a>

.. |under-development| raw:: html

<a href="https://github.com/nemtech/catapult-server/milestones/" target="_blank">under development</a>
4 changes: 0 additions & 4 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,6 @@ Continue: :doc:`Setting up your workstation <getting-started/setup-workstation>`

<a href="https://github.com/nemtech/community/" target="_blank">community</a>

.. |slack| raw:: html

<a href="https://join.slack.com/t/nem2/shared_invite/zt-hwsoo1s5-G8XO50LaY0m7ZKTRXAczcA" target="_blank">Slack</a>

.. |twitter| raw:: html

<a href="https://twitter.com/NEMofficial" target="_blank">Twitter</a>
Expand Down

0 comments on commit c6a473b

Please sign in to comment.