Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for 3.x. #207

Open
artem-zinnatullin opened this issue Mar 20, 2018 · 5 comments
Open

Update documentation for 3.x. #207

artem-zinnatullin opened this issue Mar 20, 2018 · 5 comments
Assignees
Milestone

Comments

@artem-zinnatullin
Copy link
Contributor

Most of documentation is actually compatible with 3.x, but specifically section about downloading and keeping Mainframer will need to be updated as we switch to distribution through Homebrew and other package managers #32 and OS-wide usage #185.

@arturdryomov
Copy link
Contributor

I have a radical proposition to streamline things and remove the baggage.

The proposed documentation structure:

.
└── docs
    ├── configuration
    │   ├── mainframe.md
    │   ├── user-examples.md
    │   └── user.md
    ├── integrations
    │   └── intellij-idea.md
    └── setup
        ├── mainframe.md
        └── user.md
  • As you can see I’ve replaced local and remote terms with user (as user terminal) and mainframe. Over time I feel that everybody invents their own name for machines and we might as well bring our own terms more in line with the Mainframer naming. Hopefully it will stick better.
  • Recipes are gone since the naming was wrong all along. In my understanding recipes are more about how to use the tool instead of how to use other tools with the tool.
  • Samples are gone for a couple of reasons: it is painful to support them, as tests they play zero to none purpose (otherwise the test suite is bad) and, more importantly, GitHub traffic stats show that people do not open them (except the Android one but we have Android Studio docs here for some reason). I’ve replaced them withconfiguration/user-examples.md which will contain various ignore.yml which actually play a purpose in samples.
  • Not to worry — configuration/mainframe.md will contain a single phrase like _Mainframe does not have any configuration except SSH`.

@artem-zinnatullin, if you agree, I can start implementing this.

@artem-zinnatullin
Copy link
Contributor Author

In general I'm in favor of change, but I do have comments

  • Definitely not a fan of "mainframe" and "user" (wut), I'd like us to be consistent with configs and use same terminology, like "remote" and "local"
  • "user-examples" should be a directory similar to "integrations", imo, it looks weird in "configuration" dir

@arturdryomov
Copy link
Contributor

Thought about configs as well but we use push and pull already.

@artem-zinnatullin
Copy link
Contributor Author

Damn it

@artem-zinnatullin
Copy link
Contributor Author

Wait, we still have "remote" in config, let's keep "remote" and "local" then?

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

No branches or pull requests

2 participants