Skip to content

Doc updates from Sanity checking 1.0 release

I will try to fix the doc issues Marcin identified in the 1.0 sanity checking.

  • In the Stork Tool section of our ARM we have this text: "To initialize the database directly, the Stork Tool must be built and used to initialize and upgrade the database to the latest schema. However, this is optional, as the database migration is triggered automatically upon server startup."

In fact, the rake install_server builds and installs the tool. So, there is no optionality.

I didn't find this and actually, it seems to me that the explanation implies it is triggered automatically so I don't see the problem...?

  • The stork-agent man page (perhaps other man pages too), says this:
       Once Stork becomes more mature, ISC will provide professional support for Stork services.

It should be removed.

I removed this from several places.

  • Stork Agent has a silly brief description in its help:
./stork-agent --help
NAME:
   Stork Agent - A new cli application

completely agree this should be fixed but I couldn't find where this text is.

A new cli application?

  • "Submitting MR" section in CONTRIBUTING.md should be updated to remove Godfryd and add Slawek.

  • This TODO in CONTRIBUTING.md doesn't make sense: "TODO: Describe how to run unit-tests and system tests for Stork" because the previous section describes how to run the unit tests.

  • CONTRIBUTING.md: we should remove Godfryd from here:

"ask someone from the ISC team to give you permission to fork Stork** (ask @tomek, @vicky, @ondrej or @godfryd or basically anyone from the Stork dev team)".

  • Another nit in the README.md. I think we should remove this sentence: "Stork is in early stages of its development, but it's getting new features rapidly". It will take some time to get new fancy features but we accomplished a major milestone, so saying it is in early stage is probably a bit confusing.

  • A nit in the AUTHORS.md file: the agent should be also included on my list of components.

Edited by Vicky Risk