Skip to content

Typo in Developer Guide #46

@agnesnatasya

Description

@agnesnatasya

I was trying to set up Singa-auto in my local system, however I realised that there are several typos in the Developer Guide.

In the 'setup.rst' file

  • There are some instructions to do bash scripts/start.sh but according to the files in this repository, it should be either bash scripts/kubernetes/start.sh or bash scripts/docker_swarm/start.sh

In the 'development.rst' file

  • There is an instruction to 'Before running any individual scripts, make sure to run the shell configuration script: source .env.sh'. However, when I ran it, it gave me an error because there is no such file found. I believe it should be source ./scripts/docker_swarm/.env.sh instead.
  • In the section 'Managing Rafiki's DB' afterwards, there are some typos as well. All of the variables still have 'rafiki' as its name, and I believe it should be change to Singa-auto instead. I encountered some error when trying to do this part as well.

In the 'folder-structure.rst' file

  • As mentioned above, there is no .env.sh in the root directory anymore so I believe it should not be there in the folder structure file.
  • There are some discrepancies as well to the folder structure description, as the folders are no longer structured as described in this file.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions