Mirroristas/planetmint
2
0
Fork 0
mirror of https://github.com/planetmint/planetmint.git synced 2025-03-30 15:08:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

moved doc-refs from .com to .io (#203)

Browse Source 
Signed-off-by: Jürgen Eckel <juergen@riddleandcode.com>
This commit is contained in:
Jürgen Eckel 2022-07-12 15:37:13 +02:00 committed by GitHub
parent d4830011aa
commit f7f5d2107f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
29 changed files with 33 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
.github/CONTRIBUTING.md vendored
View File

@ -1,14 +0,0 @@
<!---
Copyright © 2020 Interplanetary Database Association e.V.,
Planetmint and IPDB software contributors.
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
Code is Apache-2.0 and docs are CC-BY-4.0
--->
# How to Contribute to the Planetmint Project
There are many ways you can contribute to the Planetmint project, some very easy and others more involved.
All of that is documented elsewhere: go to the "[Contributing to Planetmint" docs on ReadTheDocs](https://docs.planetmint.com/projects/contributing/en/latest/index.html).
Note: GitHub automatically links to this file (`.github/CONTRIBUTING.md`) when a contributor creates a new issue or pull request, so you shouldn't delete it. Just use it to point people to full and proper help elsewhere.

20
.github/ISSUE_TEMPLATE.md vendored
View File

@ -1,20 +0,0 @@
# Do you want to:
- make a bug report? Then read below about what should go in a bug report.
- make a feature request or proposal? Then read [the page about how to make a feature request or proposal](https://docs.planetmint.com/projects/contributing/en/latest/ways-can-contribute/make-a-feature-request-or-proposal.html).
- ask a question about Planetmint? Then [go to Gitter](https://gitter.im/planetmint/planetmint) (our chat room) and ask it there.
- share your neat idea or realization? Then [go to Gitter](https://gitter.im/planetmint/planetmint) (our chat room) and share it there.
# What Should Go in a Bug Report
- What computer are you on (hardware)?
- What operating system are you using, including version. e.g. Ubuntu 14.04? Fedora 23?
- What version of Planetmint software were you using? Is that the latest version?
- What, exactly, did you do to get to the point where you got stuck? Describe all the steps so we can get there too. Show screenshots or copy-and-paste text to GitHub.
- Show what actually happened.
- Say what you tried to do to resolve the problem.
- Provide details to convince us that it matters to you. Is it for a school project, a job, a contract with a deadline, a child who needs it for Christmas?
We will do our best but please understand that we don't have time to help everyone, especially people who don't care to help us help them. "It doesn't work." is not going to get any reaction from us. We need _details_.
Tip: Use Github code block formatting to make code render pretty in GitHub. To do that, put three backticks followed by a string to set the type of code (e.g. `Python`), then the code, and then end with three backticks. There's more information about [inserting code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/) in the GitHub help pages.

30
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -1,30 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
**Expected behavior**
A clear and concise description of what you expected to happen.
**Logs or terminal output**
If applicable, add add textual content to help explain your problem.
**Desktop (please complete the following information):**
- Distribution: [e.g. Ubuntu 18.04]
- Bigchaindb version:
- Tendermint version:
- Mongodb version:
- Python full version: [e.g. Python 3.9.3]
**Additional context**
Add any other context about the problem here.

18
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,18 +0,0 @@
Make sure the title of this pull request has the form:
**Problem: A short statement of the problem.**
## Solution
A short statement about how this PR solves the **Problem**.
## Issues Resolved
What issues does this PR resolve, if any? Please include lines like the following (i.e. "Resolves #NNNN), so that when this PR gets merged, GitHub will automatically close those issues.
Resolves #NNNN
Resolves #MMMM
## BEPs Implemented
What [BEPs](https://github.com/planetmint/beps) does this pull request implement, if any?

2
CODE_OF_CONDUCT.md
View File

@ -42,7 +42,7 @@ This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior directed at yourself or another community member may be
reported by contacting a project maintainer at [contact@planetmint.com](mailto:contact@planetmint.com). All
reported by contacting a project maintainer at [mail@planetmint.io](mailto:contact@planetmint.io). All
complaints will be reviewed and investigated and will result in a response that
is appropriate to the circumstances. Maintainers are
obligated to maintain confidentiality with regard to the reporter of an

7
README.md
View File

@ -54,14 +54,11 @@ To view all commands available, run `make`.
## Links for Everyone
* [Planetmint.io](https://www.planetmint.io/) - the main Planetmint website, including newsletter signup
* [Roadmap](https://github.com/planetmint/org/blob/master/ROADMAP.md)
* [Blog](https://medium.com/the-planetmint-blog)
* [Twitter](https://twitter.com/Planetmint)
## Links for Developers
* [All Planetmint Documentation](https://docs.planetmint.com/en/latest/)
* [Planetmint Server Documentation](https://docs.planetmint.com/projects/server/en/latest/index.html)
* [All Planetmint Documentation](https://docs.planetmint.io/en/latest/)
* [Planetmint Server Documentation](https://docs.planetmint.io/projects/server/en/latest/index.html)
* [CONTRIBUTING.md](.github/CONTRIBUTING.md) - how to contribute
* [Community guidelines](CODE_OF_CONDUCT.md)
* [Open issues](https://github.com/planetmint/planetmint/issues)

3
acceptance/python/src/test_basic.py
View File

@ -14,9 +14,6 @@
#
# We run a series of checks for each steps, that is retrieving the transaction from
# the remote system, and also checking the `outputs` of a given public key.
#
# This acceptance test is a rip-off of our
# [tutorial](https://docs.planetmint.com/projects/py-driver/en/latest/usage.html).
# ## Imports
# We need some utils from the `os` package, we will interact with

3
acceptance/python/src/test_divisible_asset.py
View File

@ -15,9 +15,6 @@
# We run a series of checks for each step, that is retrieving
# the transaction from the remote system, and also checking the `amount`
# of a given transaction.
#
# This integration test is a rip-off of our
# [tutorial](https://docs.planetmint.com/projects/py-driver/en/latest/usage.html).
# ## Imports
# We need some utils from the `os` package, we will interact with

4
acceptance/python/src/test_multiple_owners.py
View File

@ -15,9 +15,7 @@
# We run a series of checks for each step, that is retrieving
# the transaction from the remote system, and also checking the public keys
# of a given transaction.
#
# This integration test is a rip-off of our
# [tutorial](https://docs.planetmint.com/projects/py-driver/en/latest/usage.html).
# ## Imports
# We need some utils from the `os` package, we will interact with

2
docs/root/source/connecting/http-samples/api-index-response.http
View File

@ -4,7 +4,7 @@ Content-Type: application/json
{
"assets": "/assets/",
"blocks": "/blocks/",
"docs": "https://docs.planetmint.com/projects/server/en/v1.0.1/http-client-server-api.html",
"docs": "https://docs.planetmint.io/projects/server/en/v1.0.1/http-client-server-api.html",
"metadata": "/metadata/",
"outputs": "/outputs/",
"streamedblocks": "ws://localhost:9985/api/v1/streams/valid_blocks",

4
docs/root/source/connecting/http-samples/index-response.http
View File

@ -6,7 +6,7 @@ Content-Type: application/json
"v1": {
"assets": "/api/v1/assets/",
"blocks": "/api/v1/blocks/",
"docs": "https://docs.planetmint.com/projects/server/en/v1.0.1/http-client-server-api.html",
"docs": "https://docs.planetmint.io/projects/server/en/v1.0.1/http-client-server-api.html",
"metadata": "/api/v1/metadata/",
"outputs": "/api/v1/outputs/",
"streamedblocks": "ws://localhost:9985/api/v1/streams/valid_blocks",
@ -15,7 +15,7 @@ Content-Type: application/json
"validators": "/api/v1/validators"
}
},
"docs": "https://docs.planetmint.com/projects/server/en/v1.0.1/",
"docs": "https://docs.planetmint.io/projects/server/en/v1.0.1/",
"software": "Planetmint",
"version": "1.0.1"
}

2
docs/root/source/contributing/cross-project-policies/code-of-conduct.md
View File

@ -42,7 +42,7 @@ This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior directed at yourself or another community member may be
reported by contacting a project maintainer at [contact@planetmint.com](mailto:contact@planetmint.com). All
reported by contacting a project maintainer at [mail@planetmint.io](mailto:mail@planetmint.io). All
complaints will be reviewed and investigated and will result in a response that
is appropriate to the circumstances. Maintainers are
obligated to maintain confidentiality with regard to the reporter of an

2
docs/root/source/terminology.md
View File

@ -80,7 +80,7 @@ You could do more elaborate things too. As one example, each time someone writes
### Role-Based Access Control (RBAC)
In September 2017, we published a [blog post about how one can define an RBAC sub-system on top of Planetmint](https://blog.planetmint.com/role-based-access-control-for-planetmint-assets-b7cada491997).
In September 2017, we published a [blog post about how one can define an RBAC sub-system on top of Planetmint](https://blog.bigchaindb.com/role-based-access-control-for-bigchaindb-assets-b7cada491997).
At the time of writing (January 2018), doing so required the use of a plugin, so it's not possible using standard Planetmint (which is what's available on the [IPDB Testnet](https://test.ipdb.io/>). That may change in the future.
If you're interested, `contact IPDB <contact@ipdb.global>`_.

3
integration/python/src/test_divisible_asset.py
View File

@ -15,9 +15,6 @@
# We run a series of checks for each step, that is retrieving
# the transaction from the remote system, and also checking the `amount`
# of a given transaction.
#
# This integration test is a rip-off of our
# [tutorial](https://docs.planetmint.com/projects/py-driver/en/latest/usage.html).
# ## Imports
# We need the `pytest` package to catch the `BadRequest` exception properly.

2
integration/python/src/test_multiple_owners.py
View File

@ -15,8 +15,6 @@
# We run a series of checks for each step, that is retrieving
# the transaction from the remote system, and also checking the public keys
# of a given transaction.
#
# This integration test is a rip-off of our mutliple signature acceptance tests.
# # Imports
import time

2
k8s/configuration/config-map.yaml
View File

@ -70,7 +70,7 @@ data:
openresty-backend-port: "8080"
# Planetmint configuration parameters
# Refer https://docs.planetmint.com/projects/server/en/latest/server-reference/configuration.html
# Refer https://docs.planetmint.io/en/latest/node-setup/configuration.html
# planetmint-api-port is the port number on which Planetmint is listening
# for HTTP requests.

8
k8s/nginx-https-web-proxy/nginx-https-web-proxy-conf.yaml
View File

@ -61,10 +61,10 @@ data:
# expected-http-referer is the expected regex expression of the Referer
# header in the HTTP requests to the proxy.
# The default below accepts the referrer value to be *.planetmint.com
expected-http-referer: "^https://(.*)planetmint\\.com/(.*)"
# The default below accepts the referrer value to be *.planetmint.io
expected-http-referer: "^https://(.*)planetmint\\.io/(.*)"
# expected-http-origin is the expected regex expression of the Origin
# header in the HTTP requests to the proxy.
# The default below accepts the origin value to be *.planetmint.com
expected-http-origin: "^https://(.*)planetmint\\.com"
# The default below accepts the origin value to be *.planetmint.io
expected-http-origin: "^https://(.*)planetmint\\.io"

2
k8s/scripts/functions
View File

@ -298,7 +298,7 @@ data:
openresty-backend-port: "8080"
# Planetmint configuration parameters
# Refer https://docs.planetmint.com/projects/server/en/latest/server-reference/configuration.html
# Refer https://docs.planetmint.io/en/latest/node-setup/configuration.html
# planetmint-api-port is the port number on which Planetmint is listening
# for HTTP requests.

2
k8s/scripts/vars
View File

@ -1,5 +1,5 @@
# DNS name of the planetmint node
NODE_FQDN="test.planetmint.com"
NODE_FQDN="test.planetmint.io"
# NODE_FRONTEND_PORT is the port number on which this node's services
# are available to external clients. Default is 443(https)

4
planetmint/README.md
View File

@ -17,7 +17,7 @@ The `Planetmint` class is defined here. Most node-level operations and database
### [`models.py`](./models.py)
`Block`, `Transaction`, and `Asset` classes are defined here. The classes mirror the block and transaction structure from the [documentation](https://docs.planetmint.com/projects/server/en/latest/data-models/index.html), but also include methods for validation and signing.
`Block`, `Transaction`, and `Asset` classes are defined here. The classes mirror the block and transaction structure from the documentation, but also include methods for validation and signing.
### [`validation.py`](./validation.py)
@ -35,7 +35,7 @@ Methods for managing the configuration, including loading configuration files, a
### [`commands`](./commands)
Contains code for the [CLI](https://docs.planetmint.com/projects/server/en/latest/server-reference/planetmint-cli.html) for Planetmint.
Contains code for the [CLI](https://docs.planetmint.io/en/latest/tools/index.html#command-line-interface-cli) for Planetmint.
### [`db`](./db)

2
planetmint/start.py
View File

@ -26,7 +26,7 @@ BANNER = """
* *
* You can send HTTP requests via the HTTP API documented in the *
* Planetmint Server docs at: *
* https://planetmint.com/http-api *
* https://planetmint.io/http-api *
* *
* Listening to client connections on: {:<15} *
* *

2
planetmint/web/views/assets.py
View File

@ -5,7 +5,7 @@
"""This module provides the blueprint for some basic API endpoints.
For more information please refer to the documentation: http://planetmint.com/http-api
For more information please refer to the documentation: http://planetmint.io/http-api
"""
import logging

2
planetmint/web/views/blocks.py
View File

@ -5,7 +5,7 @@
"""This module provides the blueprint for the blocks API endpoints.
For more information please refer to the documentation: http://planetmint.com/http-api
For more information please refer to the documentation: http://planetmint.io/http-api
"""
from flask import current_app
from flask_restful import Resource, reqparse

4
planetmint/web/views/info.py
View File

@ -16,7 +16,7 @@ from planetmint.web.websocket_server import EVENTS_ENDPOINT, EVENTS_ENDPOINT_BLO
class RootIndex(Resource):
def get(self):
docs_url = [
'https://docs.planetmint.com/projects/server/en/v',
'https://docs.planetmint.io/projects/server/en/v',
version.__version__ + '/'
]
return flask.jsonify({
@ -41,7 +41,7 @@ def get_api_v1_info(api_prefix):
websocket_root_tx = base_ws_uri() + EVENTS_ENDPOINT
websocket_root_block = base_ws_uri() + EVENTS_ENDPOINT_BLOCKS
docs_url = [
'https://docs.planetmint.com/projects/server/en/v',
'https://docs.planetmint.io/projects/server/en/v',
version.__version__,
'/http-client-server-api.html',
]

2
planetmint/web/views/metadata.py
View File

@ -5,7 +5,7 @@
"""This module provides the blueprint for some basic API endpoints.
For more information please refer to the documentation: http://planetmint.com/http-api
For more information please refer to the documentation: http://planetmint.io/http-api
"""
import logging

2
planetmint/web/views/transactions.py
View File

@ -5,7 +5,7 @@
"""This module provides the blueprint for some basic API endpoints.
For more information please refer to the documentation: http://planetmint.com/http-api
For more information please refer to the documentation: http://planetmint.io/http-api
"""
import logging

2
proposals/migrate-cli.md
View File

@ -166,4 +166,4 @@ N/A
## Reference(s)
* [Bigchaindb CLI](https://docs.planetmint.com/projects/server/en/latest/server-reference/planetmint-cli.html)
* [Bigchaindb CLI](https://docs.planetmint.io/en/latest/tools/index.html#command-line-interface-cli)

8
tests/README.md
View File

@ -7,11 +7,11 @@ Code is Apache-2.0 and docs are CC-BY-4.0
# Planetmint Server Unit Tests
Most of the tests in the `tests/` folder are unit tests. For info about how to write and run tests, see [the docs about contributing to Planetmint](http://docs.planetmint.com/projects/contributing/en/latest/index.html), especially:
Most of the tests in the `tests/` folder are unit tests. For info about how to write and run tests, see [the docs about contributing to Planetmint](http://docs.planetmint.io/en/latest/index.html), especially:
- [Write Code - Remember to Write Tests](http://docs.planetmint.com/projects/contributing/en/latest/dev-setup-coding-and-contribution-process/write-code.html#remember-to-write-tests)
- [Notes on Running a Local Dev Node with Docker Compose](http://docs.planetmint.com/projects/contributing/en/latest/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.html), especially `make test`
- [Write Code - Remember to Write Tests](https://docs.planetmint.io/en/latest/contributing/dev-setup-coding-and-contribution-process/write-code.html?highlight=write%20code#remember-to-write-tests)
- [Notes on Running a Local Dev Node with Docker Compose](https://docs.planetmint.io/en/latest/contributing/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.html), especially `make test`
- [
Notes on Running a Local Dev Node as Processes (and Running All Tests)](http://docs.planetmint.com/projects/contributing/en/latest/dev-setup-coding-and-contribution-process/run-node-as-processes.html)
Notes on Running a Local Dev Node as Processes (and Running All Tests)](https://docs.planetmint.io/en/latest/contributing/dev-setup-coding-and-contribution-process/run-node-as-processes.html)
Note: There are acceptance tests in the `acceptance/` folder (at the same level in the hierarchy as the `tests/` folder).

6
tests/web/test_info.py
View File

@ -10,7 +10,7 @@ from unittest import mock
@mock.patch('planetmint.version.__version__', 'tsttst')
def test_api_root_endpoint(client, wsserver_base_url):
res = client.get('/')
docs_url = ['https://docs.planetmint.com/projects/server/en/vtsttst',
docs_url = ['https://docs.planetmint.io/projects/server/en/vtsttst',
'/http-client-server-api.html']
assert res.json == {
'api': {
@ -28,7 +28,7 @@ def test_api_root_endpoint(client, wsserver_base_url):
'validators': '/api/v1/validators',
}
},
'docs': 'https://docs.planetmint.com/projects/server/en/vtsttst/',
'docs': 'https://docs.planetmint.io/projects/server/en/vtsttst/',
'version': 'tsttst',
'software': 'Planetmint',
}
@ -37,7 +37,7 @@ def test_api_root_endpoint(client, wsserver_base_url):
@mock.patch('planetmint.version.__short_version__', 'tst')
@mock.patch('planetmint.version.__version__', 'tsttst')
def test_api_v1_endpoint(client, wsserver_base_url):
docs_url = ['https://docs.planetmint.com/projects/server/en/vtsttst',
docs_url = ['https://docs.planetmint.io/projects/server/en/vtsttst',
'/http-client-server-api.html']
api_v1_info = {
'docs': ''.join(docs_url),