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

Add Software acknowledgment page #3058

Merged
merged 6 commits into from
Feb 13, 2020
Merged

Conversation

ecerami
Copy link
Contributor

@ecerami ecerami commented Feb 13, 2020

Fixes cBioPortal/cbioportal#5667

  • Added new software acknowledgment page/component.
  • Added new property: skin_documentation_software.
  • Added new /software router.
  • Added link to /software within the footer.

Note: the actual content of the software page is a markdown page, which now exists within the back-end repo, and not part of this PR. See: https://github.com/cBioPortal/cbioportal/blob/master/docs/Software-Acknowledgments.md

Any screenshots or GIFs?

  • Not applicable

Notify reviewers

@alisman @inodb or @jjgao

@@ -44,6 +44,7 @@ const ServerConfigDefaults: Partial<IServerConfig> = {
skin_authorization_message:
'Access to this portal is only available to authorized users.',
skin_documentation_about: 'About-Us.md',
skin_documentation_software: 'Software-Acknowledgments.md',
Copy link
Member

Choose a reason for hiding this comment

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

Nice US spelling of acknowledgment

FYI - If we want to allow people to update this config using portal.properties it will also need to be added to config_service.jsp in the backend. We already allow people to override the footer in its entirety, so seems overkill to add it there but just so you know

Copy link
Member

@inodb inodb left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thanks for doing this!

One minor thing is that I personally prefer imperative mood in the subject line:

https://chris.beams.io/posts/git-commit/#seven-rules

I find it makes the title more concise and therefore easier to read. Same with PR titles

Opinions about this vary tho

@ecerami
Copy link
Contributor Author

ecerami commented Feb 13, 2020

@inodb: Good tip on imperative. So, instead of "Added new route for software page" --> "Add new route for software page"?

Write back! (I think that's imperative :-)

@inodb
Copy link
Member

inodb commented Feb 13, 2020

Lol yes 🙂!

@inodb inodb changed the title Created new Software acknowledgment page Add Software acknowledgment page Feb 13, 2020
@inodb inodb merged commit 17a0b2a into cBioPortal:master Feb 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cbioportal software markdown page
2 participants