rustus icon indicating copy to clipboard operation
rustus copied to clipboard

Documentation issues

Open s3rius opened this issue 3 years ago • 5 comments
trafficstars

Please report here all found mistakes and typos in docs.

s3rius avatar Jan 07 '22 03:01 s3rius

Now we have to describe how to deploy rustus using helm, kubernetes and docker. Also everything about hooks and other features must be described.

s3rius avatar Mar 26 '22 10:03 s3rius

I guess it would be nice to have a github page for docs.

s3rius avatar Mar 26 '22 10:03 s3rius

Readme updated. Docs are now available at https://s3rius.github.io/rustus/.

Now I need to fix some mistakes in docs.

s3rius avatar Mar 29 '22 07:03 s3rius

I'm not a big English/UX expert, but there are a couple of suggestions from my side about the Welcome Page:

  1. Make rustus and Table of contents headers from the sides slightly bigger
  2. This project has many features that makes it easy to integrate in your service. -> This project has many features that make it easy to integrate into your service.
  3. You can install rustus by 4 different ways. -> You can install Rustus in four different ways.
  4. To build it from source rust must be installed. Preferred version is 1.59.0. -> To build it from the source rust must be installed. The preferred version is 1.59.0. (not 100% sure here 🤔)
  5. Also you can speedup build by disabling some features. -> Also, you can speed up the build by disabling some features.
  6. adds amqp protocol support for notifying about upload status; -> adds AMQP protocol support for notifying about upload status;
  7. adds support for notifying about upload status via http protocol; -> adds support for notifying about upload status via HTTP protocol;
  8. adds support for storing information about upload in redis database; -> adds support for storing information about upload in Redis database;
  9. If you have cargo installed maybe it would be easier to install it directly from crates.io. -> If you have Cargo installed, it might be more convenient to install Rustus directly from crates.io
  10. github -> GitHub, cpu -> CPU, os -> OS, debian -> Debian, alpine -> Alpine 😉

PavelBahBah avatar Mar 29 '22 12:03 PavelBahBah

Fixed in #69.

s3rius avatar Mar 29 '22 20:03 s3rius