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

Improved documentation #18

Closed
11 tasks done
prince-chrismc opened this issue Sep 7, 2020 · 2 comments · Fixed by #79
Closed
11 tasks done

Improved documentation #18

prince-chrismc opened this issue Sep 7, 2020 · 2 comments · Fixed by #79
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@prince-chrismc
Copy link
Owner

prince-chrismc commented Sep 7, 2020

There is currently a few READMEs describing how to use the repository. The most incomplete would be the back-end

Document

Back-End

Front-end

Deployments

General

  • root README, leave gif? new diagram for cloud deployment? Updated descriptions 60c21a2
  • update API with new FQDNs
  • Fixup Change log 74ea914
  • Project structure/overview 60c21a2

Other Consideration

  • Code API documentation? (mostly for back-end public header)
  • Naming convention for files? (is it worth making them lowercase?)
@prince-chrismc prince-chrismc added the documentation Improvements or additions to documentation label Sep 7, 2020
@prince-chrismc prince-chrismc added this to the 1.0.0-dev.1 milestone Sep 7, 2020
@prince-chrismc
Copy link
Owner Author

-conan install user-managment/1.0.0-dev.0+`git rev-parse --short HEAD`
+conan install user-management/1.0.0-dev.0+`git rev-parse --short HEAD`@  --lockfile=build/conan.lock

@prince-chrismc prince-chrismc self-assigned this Feb 5, 2021
prince-chrismc added a commit that referenced this issue Feb 6, 2021
@prince-chrismc
Copy link
Owner Author

prince-chrismc commented Feb 7, 2021

github_changelog_generator --user prince-chrismc --project user-management --base changelog.md --output changelog-tmp.md --exclude-labels dependencies --add-sections '{"api":{"prefix":"**API updates:**","labels":["api"]}, "deploy":{"prefix":"**Deployment improvements:**","labels":["deployment"]}}' --no-author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant