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.

Sign up for GitHub

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

Jump to bottom

Project name should be reference as basin3d, basin-3d, or BASIN-3D #35

Closed
heycatwonton opened this issue Jan 29, 2021 · 1 comment
Closed

Project name should be reference as basin3d, basin-3d, or BASIN-3D #35

heycatwonton opened this issue Jan 29, 2021 · 1 comment
Assignees
@heycatwonton
Labels
discussion
Projects
Opensource 2021

Comments

@heycatwonton
Copy link
Contributor

Describe the bug
When in code, basin3d-core needs to be referenced as basin3d.
When not in code, basin3d reference should be consistent throughout the file as basin3d, basin-3d, or BASIN-3D. Sometimes in the documentation it is referenced as basin-3d, basin3d, or basin3d-core.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://github.com/iNAIADS/basin3d/blob/master/README.md
  2. Scroll down to 'basin3d-core', 'Getting Started - Get the Code', 'Develop', 'Documentation', 'Install', 'Copyright'
  3. See errors

Expected behavior
Expected consistent and accurate reference to project name in code and in documentation. Previous documents (publications) referenced project as BASIN-3D but in README file, it is not.

Screenshots
basin3d-core

  • In documentation: basin3d-core -> basin-3d or basin3d or BASIN-3D

Development Practices:

  • In documentation: basin3d-core -> basin-3d or basin3d or BASIN-3D

Develop

  • In documentation: basin3d-core -> basin-3d or basin3d or BASIN-3D
  • In documentation: basin-3d -> basin3d or basin-3d or BASIN-3D

Copyright

  • In documentation: basin3d-core -> basin-3d or basin3d or BASIN-3D

Desktop (please complete the following information):

  • OS: macOS
  • Python 3.8
  • Version 3

Additional context
When not in code, will project name be reference as basin3d, basin-3d, or BASIN-3D?
@heycatwonton heycatwonton self-assigned this Jan 29, 2021
@vchendrix vchendrix added this to To do in Opensource 2021 Feb 12, 2021
@heycatwonton heycatwonton moved this from To do to In progress in Opensource 2021 Mar 26, 2021
@heycatwonton heycatwonton mentioned this issue Mar 30, 2021
Merged
11 tasks
@heycatwonton heycatwonton moved this from In progress to Review in progress in Opensource 2021 Mar 30, 2021
heycatwonton pushed a commit that referenced this issue Apr 2, 2021
Refactor project README.md structure and Sphinx documentation
ade753a 
Adds changelog to README and Sphinx documentation. Adds contributing to README, edits install instructions. Adds copyright and license to documentation. Renames api.rst and models.rst files. Changes basin3d-core to basin3d reference in documentation. Changes setup.py. Moves items around in table of contents.

Closes #36, #35, #20
vchendrix pushed a commit that referenced this issue Apr 2, 2021
@vchendrix
Refactor project README.md structure and Sphinx documentation
6ca7473 
Adds changelog to README and Sphinx documentation. Adds contributing to README, edits install instructions. Adds copyright and license to documentation. Renames api.rst and models.rst files. Changes basin3d-core to basin3d reference in documentation. Changes setup.py. Moves items around in table of contents.

Closes #36, #35, #20
heycatwonton pushed a commit that referenced this issue Apr 5, 2021
Refactor project README.md structure and Sphinx documentation
73d14c2 
Adds changelog to README and Sphinx documentation. Adds contributing to README, edits install instructions. Adds copyright and license to documentation. Renames api.rst and models.rst files. Changes basin3d-core to basin3d reference in documentation. Changes setup.py. Moves items around in table of contents. Adds email addresses to setup.py.

Closes #36, #35, #20
heycatwonton pushed a commit that referenced this issue Apr 5, 2021
Refactor project README.md structure and Sphinx documentation
c0fafa7 
Adds authors and addresses to setup.py, points key_function in indecontent.html to key_functions.

Closes #36. References and closes #35, #20
heycatwonton pushed a commit that referenced this issue Apr 5, 2021
Refactor project README.md structure and Sphinx documentation
903acc3 
Adds authors and addresses to setup.py, points key_function in indecontent.html to key_functions.

Closes #36. References and closes #35, #20
@heycatwonton heycatwonton mentioned this issue Apr 5, 2021
Merged
12 tasks
heycatwonton pushed a commit that referenced this issue Apr 5, 2021
Refactor project README.md structure and Sphinx documentation
9477f39 
Adds authors and addresses to setup.py, points key_function in indecontent.html to key_functions.

Closes #36, #35, #20
heycatwonton pushed a commit that referenced this issue Apr 6, 2021
Refactor project README.md structure and Sphinx documentation
5afaddf 
Adds authors and addresses to setup.py, points key_function in indecontent.html to key_functions.

Closesc #35, #20
vchendrix pushed a commit that referenced this issue Apr 6, 2021
@vchendrix
Refactor project README.md structure and Sphinx documentation
5f601a4 
Adds authors and addresses to setup.py, points key_function in indecontent.html to key_functions.

Closesc #35, #20
@heycatwonton heycatwonton moved this from Review in progress to Done in Opensource 2021 Apr 13, 2021
@heycatwonton
Copy link
Contributor Author

heycatwonton commented May 4, 2021 •
edited
Loading

edit: closing manually but issue would've been closed after branch is merged to main (not release)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@heycatwonton heycatwonton

Labels
discussion
Projects
No open projects
Opensource 2021
Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@heycatwonton