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

Improve Streamlit landing page #76

Merged
merged 29 commits into from
Apr 14, 2021
Merged

Improve Streamlit landing page #76

merged 29 commits into from
Apr 14, 2021

Conversation

nathandloria
Copy link
Collaborator

In this pull request we created a new landing page to reduce redundancy generated by the README. The new landing page is in markdown format and it displays a lot of helpful information about the tool. It also shows quick instructions further explaining how to use the tools provided by GatorMiner.

What is the current behavior?

closes #60

What is the new behavior if this PR is merged?

New, less redundant landing page.

Please describe the pull request as one of the following:

  • Bug fix
  • Breaking change
  • New feature
  • Documentation update
  • Other

Other information

This PR has:

  • Commit messages that are correctly formatted
  • Tests for newly introduced code
  • Docstrings for newly introduced code

Developers

@PaigeCD @caldwella2 @angusn8 @connellyw @nathandloria

@nathandloria nathandloria added documentation Improvements or additions to documentation enhancement New feature or request Team 3 This tag serves as a `claim` for team 3 to work on the issue initially labels Apr 6, 2021
@nathandloria nathandloria changed the title Issue#60 Issue#60 : Implement improved landing page Apr 6, 2021
Copy link
Contributor

@enpuyou enpuyou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't really gotten the chance to read into the details. Most are great, just one comment below. Another thing, can you create a folder named docs, and just put this markdown file in there. It seems like there will be more documentation coming up soon, so I would like to have them all in one place. Thanks!

LANDING_PAGE.md Outdated Show resolved Hide resolved
@noorbuchi
Copy link
Collaborator

I think that your PR has multiple issues resulting from this commit 7b74560 . This reverts very important fixes. Please make sure to resolve this by restoring the deleted files and re-adding the important fixes

…al-CS/GatorMiner into issue#60""

This reverts commit 7b74560.
@nathandloria nathandloria requested a review from enpuyou April 8, 2021 16:52
Copy link
Collaborator

@noorbuchi noorbuchi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the new landing page looks great! I requested few small changes that you should address before merging this PR. Thanks for working on this helpful documentation!

docs/LANDING_PAGE.md Outdated Show resolved Hide resolved
docs/LANDING_PAGE.md Outdated Show resolved Hide resolved
docs/LANDING_PAGE.md Outdated Show resolved Hide resolved
@enpuyou enpuyou changed the title Issue#60 : Implement improved landing page Improve Streamlit landing page Apr 10, 2021
@enpuyou enpuyou removed the enhancement New feature or request label Apr 10, 2021
@codecov
Copy link

codecov bot commented Apr 10, 2021

Codecov Report

Merging #76 (af075a5) into master (9f7b389) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #76   +/-   ##
=======================================
  Coverage   91.07%   91.07%           
=======================================
  Files           6        6           
  Lines         224      224           
=======================================
  Hits          204      204           
  Misses         20       20           

Copy link
Contributor

@enpuyou enpuyou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @nathandloria, I think this PR is good! I have just added an mdl check into the Travis CI, so it would enforce markdown rules on documents in docs folder. Should anything fail (there is probably not, but just in case), just do a quick fix, I don't think it would be anything substantial. Thanks again!

@nathandloria nathandloria requested a review from noorbuchi April 14, 2021 18:53
@enpuyou enpuyou requested a review from munzekm April 14, 2021 19:08
@noorbuchi noorbuchi merged commit 99e8259 into master Apr 14, 2021
@enpuyou enpuyou deleted the issue#60 branch April 14, 2021 20:46
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 Team 3 This tag serves as a `claim` for team 3 to work on the issue initially
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement and Improve Landing Page
9 participants