anycable/docs.anycable.io

AnyCable documentation

AnyCable documentation

AnyCable docs website driven by docsify.

Contributing

The quickest way to fix a typo or propose a small change is to use GitHub web interface (open a file, click on "Edit", create a PR).

If you want to propose a bigger change, you might want to use a common flow:

1. Fork it.
2. Create a new branch (git checkout -b feat/my-proposal).
3. Commit and push changes.
4. Open new Pull Request.

Linters

We try to keep our documentation both correct and stylish using the following tools:

• mdl—Markdown linter, Ruby edition.
• liche—links linter.
• forspell—spelling checker.
• rubocop with rubocop-md and standard—Ruby code snippets style checking.

To run these tools locally we use Lefthook (runs linters automatically for every commit).

To sum up:

• Install mdl:

gem install mdl

• Install liche:

go get -u github.com/raviqqe/liche

• Install Hunspell and Forspell:

# for MacOS (for other OS see Forspell documentation)
brew install hunspell

gem install forspell

• Install StandardRB and rubocop-md:

gem install standard
gem install rubocop-md

• Install lefthook:

# for MacOS (for other OS see Lefthook documentation)
brew install lefthook

• Initialize lefthook:

lefthook install

Or you can skip all of these and rely on our CI, which can do all the checks for you!

docs.anycable.io's Issues

Add rubocop-md

• Add rubocop-md
• Configure Travis CI to run rubocop-md

Add roth to CI

Add roth to CI (when it's ready) /cc @progapandist

Consolidated list of all ENV variables

We are in the process of upgrading AnyCable. With the renaming of multiple ENV variables, it took more time than it probably should have trying to find and locate all changes through the documentation. It would help if listed on the upgrade docs (it looks like some of them were missed). I knew the setting I wanted to use, but it took time to track down the correct ENV variable name. I'd search both the docs.anycable.io, this repo, the repo's of other AnyCable github projects. Searching didn't work as I'd hoped.

One idea, create a consolidated list/dictionary of ENV variables. This page could also link to existing pages that give more explanation on why/how the ENV variables are used.

BTW, even with this "complaint"... the docs are pretty comprehensive overall.

v1.0 TODO

• Rack middlewares
• RPC and anycable-go default host changes
• Add note about cable_meta_tag (anycable/anycable-rails#115)
• Docker versioning
• anycable-go disconnector guide
• Generator GIF
• RPC proto changes:
  • Actual changes (diff?)
  • Migration plan (anycable-go v1.0 compatibility with v0.6)
  • Version check
• Stimulus Reflex
  • Session persistence
  • Cache store problem anycable/anycable-rails#127 (comment)
• Upgrade "How to write a server"
• Heroku upgrades:
  • Add note about RPC app mem size (you need 50MB per 1k connections + RPC size)
• Dark theme 😎
• Actualize blog posts links (remove "From Action to Any", add new post)
• Update home page (anycable.io)
• ...