#82 Improving the Documentation
Closed: duplicate 5 years ago by jflory7. Opened 5 years ago by alishapapun.

The following changes can be implemented for improvising the README.md file -
Intermediate Changes:


  1. Making the following sub-heading of
    1.1 Prerequisites :-
    It includes things that we need to install the software like Docker, Docker Compose,
    Python(Version 3 or above recommended)
    1.2 Installing:-
    Command to clone the repository
    OpenID Connect Client ID and Client Secret by following the present command.
    1.3 Run:-
    It includes commands to run like “docker compose up” and gives link to the
    localhost:8000
    1.4 Running the Tests
    It says about how to run the automated tests for this system.
    Minor Changes

  1. Adding a heading for Licence and linking the file.
  2. Managing the writing style of already present document.
    For example: Project title can be written as Fedora-Happiness-Packet instead of all in
    lowercase.
  3. Making “happinesspackets.io” active link rather text.

Hi @jonatoni I think these are some of the changes that are needed in the Documention. Please assign the task to me.

Metadata Update from @jflory7:
- Issue assigned to alishapapun
- Issue priority set to: waiting on assignee (was: awaiting triage)
- Issue set to the milestone: Summer Coding 2019: community bonding
- Issue tagged with: good first issue, improvement, type - docs

5 years ago

This issue is a duplicate of #70. @alishapapun also submitted a fix for this already in #93. I'm closing this ticket as a duplicate. :clapper:

Metadata Update from @jflory7:
- Issue close_status updated to: duplicate
- Issue status updated to: Closed (was: Open)

5 years ago

Login to comment on this ticket.

Metadata