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

Rename "doc" to "docs" for consistency #293

Closed
jphickey opened this issue Jun 9, 2021 · 0 comments · Fixed by #294 or #296
Closed

Rename "doc" to "docs" for consistency #293

jphickey opened this issue Jun 9, 2021 · 0 comments · Fixed by #294 or #296
Labels
enhancement New feature or request

Comments

@jphickey
Copy link
Contributor

jphickey commented Jun 9, 2021

Is your feature request related to a problem? Please describe.
Most other cFS modules put the documentation in a docs subdirectory, except OSAL and PSP, which put it in doc

Describe the solution you'd like
Be consistent, use docs since this is what cFE and the majority of cFS apps use.

Additional context
Inconsistent naming means over complicated scripts and tools, that have to look in multiple different possible names/locations

Requester Info
Joseph Hickey, Vantage Systems, Inc.
@jphickey jphickey added the enhancement New feature or request label Jun 9, 2021
jphickey added a commit to jphickey/PSP that referenced this issue Jun 9, 2021
@jphickey
Fix nasa#293, rename doc to docs
35cd912 
Just a rename, no other change.  No files appear to be referencing
doc in PSP, so no other changes should be needed at this time.
@jphickey jphickey mentioned this issue Jun 9, 2021
Merged
astrogeco added a commit that referenced this issue Jun 10, 2021
@astrogeco
Merge pull request #294 from jphickey/fix-293-docs-subdir
fd2788d 
Fix #293, rename doc to docs
@astrogeco astrogeco mentioned this issue Jun 16, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix #293, rename doc to docs jphickey/PSP
psp Integration candidate: 2021-06-15 nasa/PSP
1 participant
@jphickey