Feature/updated docs #231

Merged
merged 4 commits into from Mar 3, 2014

Conversation

Projects
None yet
2 participants
Contributor

ralphbean commented Mar 3, 2014

No description provided.

doc/deployment.rst
-<https://fedorahosted.org/fedora-infrastructure/>`_. The code should be generic
-enough to run in other environments. If you come and ask, we'll write the docs.
+This document also only goes as far as setting things up for a single machine.
+You typically deploy fedmsg across an *infrastructure*. If you just want to
@pypingou

pypingou Mar 3, 2014

Owner

s/./but/?

doc/deployment.rst
-This document isn't yet written. If you have questions about deployment, please
-come and ask in ``#fedora-apps`` on freenode or on the `mailing list
-<https://admin.fedoraproject.org/mailman/listinfo/messaging-sig>`_.
+Often, the emphasis in fedmsg docs is on how to subscribe to an existing fedmsg
@pypingou

pypingou Mar 3, 2014

Owner

s/Often/Until now/?

doc/deployment.rst
+``/var/log/fedmsg/fedmsg-relay.log``.
+
+Out of the box, it should be listening for incoming messages on
+``tcp://127.0.0.1:2003`` and re-publishing them indisrciminantly at
@pypingou

pypingou Mar 3, 2014

Owner

indisrciminantly -> typo: indiscriminately

doc/deployment.rst
+
+ config = {
+ 'datanommer.enabled': True,
+ 'datanommer.sqlalchemy.url': 'postgresql://datanommer:bunbunbun@localhost/datanommer',
@pypingou

pypingou Mar 3, 2014

Owner

s/datanommer/username/
s/bunbunbun/password/
s/datanommer/dbname/
?

@ralphbean

ralphbean Mar 3, 2014

Contributor

Just changed the password. There are examples later that use 'datanommer' for the username and dbname. Just to be consistent.

+We use a tool called `datanommer <https://github.com/fedora-infra/datanommer>`_
+to store all the messages that come across the bus in a postgres database.
+Using whatever relational database you like should be possible just by
+modifying the config.
@pypingou

pypingou Mar 3, 2014

Owner

Should the whole section about datanommer and datagrepper be in their respective doc rather than here?

@ralphbean

ralphbean Mar 3, 2014

Contributor

They are also in their own docs (READMEs in their repo). I wanted to include them here so people can just read one doc and get it all set up.

Owner

pypingou commented Mar 3, 2014

👍

Contributor

ralphbean commented Mar 3, 2014

@pypingou thanks!

@olasd, you might be interested in this. If you have any modifications, I'd love to have them.

ralphbean added a commit that referenced this pull request Mar 3, 2014

@ralphbean ralphbean merged commit 42b65ea into develop Mar 3, 2014

1 check passed

default The Travis CI build passed
Details

@ralphbean ralphbean deleted the feature/updated-docs branch Mar 3, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment