Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A touch up to the documentation issue i pointed on github, i did a fe… #669

Closed

Conversation

EbukaOkoye
Copy link

…w things to the documentation. First, i changed the windows setup to installation and project software requirement setup for first time users to know that those are what are required to be installed to fully access the zubhub project. Secondly, i described the processes of installation for docker, docker compose, node, npm, and make for the most used operating systems which are windows, linux and mac OS. this will enable users with any of the operating systems read through the documentation and install these softwares with little or no hassle.

Summary

Description of PR here...
Closes #85, Closes #22

Changes

  • Item 1
  • Item 2
  • Item 3

Screenshots

(Insert image, only for frontend)

Requests / Responses

Request
(Only for backend)
POST /api/users Returns a list of users

{
  "data": {
    "attributes": {
      "name": "The Dude",
      "email": "[email protected]",
      "password": "hellopassword"
    }
  },
  "type": "users"
}

Response
(Only for backend)
HTTP/1.1 200 OK

{
  "data": {
    "type": "users",
    "id": "4",
    "attributes": {
      "name": "The Dude",
      "email": "[email protected]",
      "last-logged-in": null,
      "created-at": "2016-10-20T17:45:08.190Z",
      "updated-at": "2016-10-20T17:45:08.190Z"
    },
    "links": {
      "self": "/users/4"
    }
  }
}

…w things to the documentation. First, i changed the windows setup to installation and project software requirement setup for first time users to know that those are what are required to be installed to fully access the zubhub project. Secondly, i described the processes of installation for docker, docker compose, node, npm, and make for the most used operating systems which are windows, linux and mac OS. this will enable users with any of the operating systems read through the documentation and install these softwares with little or no hassle.
@tuxology
Copy link
Member

Thanks. I think the docs are a bit too detailed in some places for example:

  • Step by step installation instructions and details of Docker on mac, windows
  • Details about manual installation of docker-compose etc.
  • Instructions on installing node

These detailed instructions are either available in the respected upstream projects or are out of the scope of our documentation, hence closing this! Thanks for trying out ZubHub 🙏

@tuxology tuxology closed this Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants