Review documentation

[artur-intech]

№ 1: https://github.com/internetee/registry/blob/master/doc/whois.rm

• Outdated and serves no purpose

---

№ 2: https://github.com/internetee/registry/blob/master/doc/testing.md

• "Testing" section states obvious thing
• "Testing EPP" is not valid anymore

---

№ 3: https://github.com/internetee/registry/blob/master/doc/controllers_brief.svg https://github.com/internetee/registry/blob/master/doc/controllers_complete.svg https://github.com/internetee/registry/blob/master/doc/models_brief.svg https://github.com/internetee/registry/blob/master/doc/models_complete.svg

• Outdated

---

№ 4: https://github.com/internetee/registry/blob/master/README.md The following sections are not valid anymore along with № 2.

• "Updating documentation"
• "Autotesting"

[vohmar]

@artur-beljajev no, these docs need to be updated, not removed

[artur-intech]

Why do we need them?

[vohmar]

it explains how the system works - data models have been a big help in the past. Documentation is good in case things are not self-explanatory.

[artur-intech]

ok, then we probably need to automate this process somehow, since above mentioned docs can get outdated extremely easily (as they are now).

[vohmar]

yes, please do. These schemas were automatically generated by the initial developers

[artur-intech]

I submit removal of № 1, 2, 4. Concerning № 3, they give no benefit, IMHO. They don't explain how the system works, they just provide raw data of database columns and model relationship, which are anyway available by just looking at DB or models directly. Instead of investing time to support docs, I would invest this time in making the code more understandable.

If you still prefer to automate this, I kindly ask to explain the benefits we gain if we do this.

[vohmar]

no1 might be necessary for modular architecture no2 seems necessary as it guides the setup of the autotest environment.
no3 db complete model must be kept updated no4 update as necessary

[artur-intech]

All registry demo data can be found at:
db/seeds.rb

is also outdated

[artur-intech]

https://github.com/internetee/registry/blob/master/doc/epp-examples.md#epp-domain-with-valid-domain-returns-domain-info

Request: <domain:pw>2fooBAR</domain:pw> Response: <domain:pw>98oiewslkfkd</domain:pw>

Request transfer code is not needed according to https://github.com/internetee/registry/blob/master/doc/epp/domain.md#domain-info, therefore needs to be removed. Otherwise it is confusing example.

[vohmar]

just as a reminder we need to update these documents in addition to other doc existing and mentioned in this ticket (added links to rejected PRs as reference):

• database diagrams (https://github.com/internetee/registry/pull/1073)
• mod-epp doc needs to be replaced with epp-proxy doc (https://github.com/internetee/registry/pull/1284)
• autotest setup (https://github.com/internetee/registry/pull/1285)

there are gems used to update documentation previously. Some of these gems are listed here:

• https://github.com/internetee/registry/pull/1358/files

[yulgolem]

2, 4 updated by https://github.com/internetee/registry/pull/1284

[yulgolem]

3 there is no need to store in project, RubyMine generates them on the fly (https://www.jetbrains.com/help/ruby/working-with-diagrams.html#class_diagram).