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

Documentation for Travel Mate app #557

Open
jtj9817 opened this Issue Nov 19, 2018 · 18 comments

Comments

Projects
None yet
5 participants
@jtj9817
Copy link
Contributor

jtj9817 commented Nov 19, 2018

Documentation

I would like to submit a proposal for a documentation of the app so that future contributors to the project will have an easier understanding of the codebase. This is just an idea that came up to me as I was investigating the previous issues that I've worked at. A documentation for this project can be really helpful because I haven't seen any activity from the main people that contributed to the original codebase of the project.

That said, the intended documentation will be stored besides the 'Android' folder of the app so people will immediately notice it. The documentation will have files for diagrams and API documentation of the project's components.

As an example of the diagram I'm referring to:

Would you like to work on the issue?

I can start the work on the issue and other people can help me in documenting it.

@Swati4star

This comment has been minimized.

Copy link
Member

Swati4star commented Nov 20, 2018

I have few doubts regarding this:

  • Are you planning to create this chart manually, or do you have automation tool for this? If manually, the cost of updating the class diagram along with the code changes might be an issue.
  • Do you wish to add these in wiki page only or someplace else?
@jtj9817

This comment has been minimized.

Copy link
Contributor Author

jtj9817 commented Nov 21, 2018

My first idea is to create these charts manually but I will start looking into automation tools that can make diagrams of classes and functions. I'm thinking Rational Rose/StarUML might have these features but I will need to research them first.

My current plan is to create a PDF file that has the documentation. Of course I can also add them to the wiki but that will involve the authorization for me to edit the wiki.

@Swati4star

This comment has been minimized.

Copy link
Member

Swati4star commented Nov 23, 2018

Dont create the charts manually, the maintenance of those charts will be an issue then.
Search for some automation tools only for this.

@jtj9817

This comment has been minimized.

Copy link
Contributor Author

jtj9817 commented Nov 23, 2018

I found a method to do it using automated UML-generating tool but it will need to be imported on Gradle as an add-on.

https://stackoverflow.com/questions/17123384/how-to-generate-class-diagram-uml-on-android-studio-intellij-idea/36823007#36823007

@Swati4star

This comment has been minimized.

Copy link
Member

Swati4star commented Nov 24, 2018

Did you want that kind of output only? (the type that is there in the link you have mentioned)

@jtj9817

This comment has been minimized.

Copy link
Contributor Author

jtj9817 commented Nov 25, 2018

It's not the only output that I want for the documentation but it makes the documentation easier. I still need to provide a description for the functions so that if there's a bug found in the future, future contributors can find it easily.

@Swati4star

This comment has been minimized.

Copy link
Member

Swati4star commented Dec 17, 2018

https://stackoverflow.com/questions/17123384/how-to-generate-class-diagram-uml-on-android-studio-intellij-idea/36823007#36823007

@jtj9817 This link looks good. Just create a new PR with:

  • a new folder which contains these diagrams
  • a link to the above folder in the readme
@Swati4star

This comment has been minimized.

Copy link
Member

Swati4star commented Feb 16, 2019

@jtj9817 any updates here?

@jtj9817

This comment has been minimized.

Copy link
Contributor Author

jtj9817 commented Feb 16, 2019

I will make a PR concerning this Issue within the next 2 weeks. If any problem comes up, I'll discuss it here.

@narendrasinghsolanki

This comment has been minimized.

Copy link

narendrasinghsolanki commented Feb 16, 2019

how to run this project on android studio

@narendrasinghsolanki

This comment has been minimized.

Copy link

narendrasinghsolanki commented Feb 18, 2019

@thedevelopersanjeev

This comment has been minimized.

Copy link
Member

thedevelopersanjeev commented Feb 18, 2019

Hello @narendrasinghsolanki
Open Terminal/GitBash(if using windows)
and
write command git clone git@github.com:project-travel-mate/Travel-Mate.git

@Rita-Okonkwo

This comment has been minimized.

Copy link

Rita-Okonkwo commented Feb 20, 2019

Hello is this still an issue or has it been solved? Also, are all the issues recent ones that require a solution? Looking forward to your kind and urgent response

@jtj9817

This comment has been minimized.

Copy link
Contributor Author

jtj9817 commented Feb 20, 2019

This issue is still being worked on. To be more specific, I can be certain that there would be no pull request at the end of this week as I'm currently preoccupied. Next week seems to be a better time to continue working on the Issue.

@Rita-Okonkwo

This comment has been minimized.

Copy link

Rita-Okonkwo commented Feb 20, 2019

Alright thanks

@narendrasinghsolanki

This comment has been minimized.

Copy link

narendrasinghsolanki commented Feb 20, 2019

@Swati4star Swati4star added the gssoc19 label Feb 26, 2019

jtj9817 added a commit to jtj9817/Travel-Mate that referenced this issue Mar 6, 2019

Added UML Diagrams for Issue project-travel-mate#557
These diagrams are added automatically using SimpleUMLCE. SimpleUMLCE is installed as a plug-in for Android Studio and enables automatic creation of UML files by selecting the appropriate target files.

jtj9817 added a commit to jtj9817/Travel-Mate that referenced this issue Mar 6, 2019

@jtj9817

This comment has been minimized.

Copy link
Contributor Author

jtj9817 commented Mar 8, 2019

For everyone that still wants to work on this Issue, a PR was opened up 2 days ago to deal with this Issue. The PR can be seen here: #571

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.