Skip to content
This repository was archived by the owner on Nov 26, 2018. It is now read-only.

Clean up installation steps and docs #76

Merged
merged 20 commits into from
Sep 12, 2014
Merged

Clean up installation steps and docs #76

merged 20 commits into from
Sep 12, 2014

Conversation

unbracketed
Copy link
Contributor

  • Restores use of the .env file for configuration
  • Updates docs to reflect recent changes

@@ -42,21 +42,21 @@ Now that your bot is connected to a network or server, you can start having it j

1. Go to ``http://localhost:8000/admin/bots/channel/add/``
2. Select your bot from the dropdown
3. **Channel**: ``#botbot-test``
3. **Channel**: ``#botbot-warmup``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#botwar is sort of an official test bed channel for bots. Doesn't really matter either way, just thought I'd mention it.

@ipmb
Copy link
Member

ipmb commented Jul 10, 2014

If we're going back to .env I'd like to be sympathetic to the concerns @bartTC raised during setup.

  • dotenv is magical and we should explicitly call out what's happening in the installation docs
  • honcho isn't good when you want to hack on a specific component. We could point people towards how to start up the other bits with honcho honcho start -c bot=0, then manually source the .env with export $(cat .env | grep -v ^# | xargs) for example.

Another alternativeis to fold dotenv into the project and make it log a line out to console when an .env file is found and sourced. That removes some of the magic.

@unbracketed
Copy link
Contributor Author

Sounds good to me. This ticket covers part of that: #13

@unbracketed
Copy link
Contributor Author

I've added this companion PR that helps address some of the concerns. The bot process will now use the .env file BotBotMe/botbot-bot#28

@yml
Copy link
Member

yml commented Jul 11, 2014

I am 👎 on the usage on the usage of django-dotenv==1.2 as I prefer the 12factor approach where the apps (botbot-*) read from the environment variables.

@bartTC
Copy link
Member

bartTC commented Jul 11, 2014

Why do we use this django-dotenv again? I thought we were explicitly saying it's too magical and we go a leaner, simpler and direct approach. I dont see the need for it, you can simply source the .env file before doing anything. And then you dont rely on any Django stuff. Especially when you work on the Go part.

@unbracketed
Copy link
Contributor Author

My initial goal is to get back to having the installation work as seamlessly as possible and the docs clearly describe the steps required. For this I've chosen to utilize the .env strategy that we initially had and work is concluding on this phase.

In future iterations we can start looking at less reliance on the .env file. If you feel strongly about it, help is appreciated.

@unbracketed
Copy link
Contributor Author

I'm on the fence about recommending #botwar because it requires an identified nick. My hope was to get people up and running without having to explicitly register a nick first (our getting started docs currently say it isn't necessary). Maybe we just encourage people to register a nick first? Seems like a 'hassle' if you just wanted to kick the tires quickly.

What does everyone think?

@ipmb
Copy link
Member

ipmb commented Jul 11, 2014

Yeah, that's another hoop to jump through. It's fine to connect to another
channel.

@unbracketed
Copy link
Contributor Author

Can we merge this in?

unbracketed pushed a commit that referenced this pull request Sep 12, 2014
Clean up installation steps and docs
@unbracketed unbracketed merged commit e20ac17 into master Sep 12, 2014
@vbabiy vbabiy deleted the fix-installation branch January 15, 2015 20:29
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants