Skip to content

Commit

Permalink
Update documentation to reference faust-streaming (#290)
Browse files Browse the repository at this point in the history
Co-authored-by: Vikram Patki <54442035+patkivikram@users.noreply.github.com>
  • Loading branch information
dude0001 and patkivikram authored Mar 28, 2022
1 parent 63af9f5 commit 26d2fb6
Show file tree
Hide file tree
Showing 13 changed files with 27 additions and 26 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
*Note*: Before submitting this pull request, please review our [contributing
guidelines](https://faust.readthedocs.io/en/master/contributing.html).
guidelines](https://fauststream.com/en/latest/contributing.html).

## Description

Expand Down
1 change: 1 addition & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,4 @@ The award for doing this in any significant capacity for one year or longer, is
| Eran Kampf | <ekampf@users.noreply.github.com> |
| Wjatscheslaw Kewlin | <Wjatscheslaw.Kewlin@d-fine.de> |
| Ramkumar M | <ramchiyan1093@gmail.com> |
| Mark Lambert | <mark.lambert@gmail.com> |
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@

## Documentation

- `introduction`: http://faust.readthedocs.io/en/latest/introduction.html
- `quickstart`: http://faust.readthedocs.io/en/latest/playbooks/quickstart.html
- `User Guide`: http://faust.readthedocs.io/en/latest/userguide/index.html
- `introduction`: https://fauststream.com/en/latest/introduction.html
- `quickstart`: https://fauststream.com/en/latest/playbooks/quickstart.html
- `User Guide`: https://fauststream.com/en/latest/userguide/index.html

## Why the fork

Expand Down Expand Up @@ -285,7 +285,7 @@ Aerospike can be enabled as the state store by specifying

By default all tables backed by Aerospike use `use_partitioner=True` and generate changelog topic events similar
to a state store backed by RocksDB.
The following configuration options should be passed in as keys to the options parameter in [Table](https://faust.readthedocs.io/en/latest/reference/faust.tables.html)
The following configuration options should be passed in as keys to the options parameter in [Table](https://fauststream.com/en/latest/reference/faust.tables.html)
`namespace` : aerospike namespace

`ttl`: TTL for all KV's in the table
Expand Down Expand Up @@ -355,7 +355,7 @@ you are not currently using a virtualenv.
You can install the latest snapshot of Faust using the following `pip` command:

```sh
pip install https://github.com/robinhood/faust/zipball/master#egg=faust
pip install https://github.com/faust-streaming/faust/zipball/master#egg=faust
```

## FAQ
Expand Down Expand Up @@ -428,15 +428,15 @@ For discussions about the usage, development, and future of Faust, please join t
### Bug tracker

If you have any suggestions, bug reports, or annoyances please report them
to our issue tracker at https://github.com/robinhood/faust/issues/
to our issue tracker at https://github.com/faust-streaming/faust/issues/

## License

This software is licensed under the `New BSD License`. See the `LICENSE` file in the top distribution directory for the full license text.

### Contributing

Development of `Faust` happens at [GitHub](https://github.com/robinhood/faust)
Development of `Faust` happens at [GitHub](https://github.com/faust-streaming/faust)

You're highly encouraged to participate in the development of `Faust`.

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
project='Faust',
version_dev='1.1',
version_stable='1.0',
canonical_url='http://faust.readthedocs.io',
canonical_url='https://fauststream.com/en/latest',
webdomain='',
github_project='robinhood/faust',
copyright='2017-2020',
Expand Down
14 changes: 7 additions & 7 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Issue Trackers
Bugs for a package in the Faust ecosystem should be reported to the relevant
issue tracker.

* :pypi:`Faust` - https://github.com/robinhood/faust/issues
* :pypi:`Faust` - https://github.com/faust-streaming/faust/issues
* :pypi:`Mode` - https://github.com/ask/mode/issues

If you're unsure of the origin of the bug you can ask the
Expand Down Expand Up @@ -191,12 +191,12 @@ Branches

Current active version branches:

* dev (which git calls "master") (https://github.com/robinhood/faust/tree/master)
* 1.0 (https://github.com/robinhood/faust/tree/1.0)
* dev (which git calls "master") (https://github.com/faust-streaming/faust/tree/master)
* 1.0 (https://github.com/faust-streaming/faust/tree/1.0)

You can see the state of any branch by looking at the Changelog:

https://github.com/robinhood/faust/blob/master/Changelog.rst
https://github.com/faust-streaming/faust/blob/master/Changelog.rst

If the branch is in active development the topmost version info should
contain meta-data like:
Expand Down Expand Up @@ -317,7 +317,7 @@ to upstream changes:
.. sourcecode:: console

$ cd faust
$ git remote add upstream git://github.com/robinhood/faust.git
$ git remote add upstream git://github.com/faust-streaming/faust.git
$ git fetch upstream

If you need to pull in new changes from upstream you should
Expand Down Expand Up @@ -794,11 +794,11 @@ Packages
``Faust``
---------

:git: https://github.com/robinhood/faust
:git: https://github.com/faust-streaming/faust
:CI: http://travis-ci.org/#!/robinhood/faust
:Windows-CI: https://ci.appveyor.com/project/ask/faust
:PyPI: :pypi:`faust`
:docs: https://faust.readthedocs.io
:docs: https://fauststream.com/en/latest/

``Mode``
--------
Expand Down
2 changes: 1 addition & 1 deletion docs/includes/installation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -116,4 +116,4 @@ You can install the latest snapshot of Faust using the following

.. sourcecode:: console

$ pip install https://github.com/robinhood/faust/zipball/master#egg=faust
$ pip install https://github.com/faust-streaming/faust/zipball/master#egg=faust
2 changes: 1 addition & 1 deletion docs/includes/resources.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Bug tracker
-----------

If you have any suggestions, bug reports, or annoyances please report them
to our issue tracker at https://github.com/robinhood/faust/issues/
to our issue tracker at https://github.com/faust-streaming/faust/issues/

.. _license:

Expand Down
4 changes: 2 additions & 2 deletions docs/includes/tags.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:Version: 1.10.4
:Web: http://faust.readthedocs.io/
:Web: https://fauststream.com/en/latest
:Download: http://pypi.org/project/faust
:Source: http://github.com/robinhood/faust
:Source: http://github.com/faust-streaming/faust
:Keywords: distributed, stream, async, processing, data, queue, state management

4 changes: 2 additions & 2 deletions docs/templates/readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Faust is...
Contributing
============

Development of `Faust` happens at GitHub: https://github.com/robinhood/faust
Development of `Faust` happens at GitHub: https://github.com/faust-streaming/faust

You're highly encouraged to participate in the development
of `Faust`.
Expand All @@ -42,7 +42,7 @@ Be sure to also read the `Contributing to Faust`_ section in the
documentation.

.. _`Contributing to Faust`:
http://faust.readthedocs.io/en/latest/contributing.html
https://fauststream.com/en/latest/contributing.html

.. include:: ../includes/code-of-conduct.txt

Expand Down
2 changes: 1 addition & 1 deletion examples/django/proj/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
__version__ = '0.9.3'
__author__ = 'Robinhood Markets, Inc.'
__contact__ = 'opensource@robinhood.com'
__homepage__ = 'http://faust.readthedocs.io'
__homepage__ = 'https://fauststream.com/en/latest'
__docformat__ = 'restructuredtext'

# -eof meta-
Expand Down
2 changes: 1 addition & 1 deletion extra/release/sphinx2rst_config.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
REFBASE = 'http://faust.readthedocs.io/en/latest'
REFBASE = 'https://fauststream.com/en/latest'
REFS = {
'slack-channel': 'getting-started/resources.html#slack-channel',
'bundles': 'introduction/installation.html#bundles',
Expand Down
2 changes: 1 addition & 1 deletion faust/cli/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@ def cli(*args: Any, **kwargs: Any) -> None: # pragma: no cover
Use --help for help, --version for version information.
https://faust.readthedocs.io
https://fauststream.com/en/latest
"""
return _prepare_cli(*args, **kwargs)

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ def do_setup(**kwargs):
project_urls={
"Bug Reports": "https://github.com/faust-streaming/faust/issues",
"Source": "https://github.com/faust-streaming/faust",
"Documentation": "https://faust.readthedocs.io/",
"Documentation": "https://fauststream.com/en/latest",
},
keywords=[
"stream",
Expand Down

0 comments on commit 26d2fb6

Please sign in to comment.