Skip to content

Conversation

@ann0see
Copy link
Member

@ann0see ann0see commented Jan 25, 2022

Short description of changes
Moves/deletes some files to a newly created folder. Maybe we need to overthink the documentation structure. Having too many files in the root folder is confusing.

Context: Fixes an issue?
Not yet.

Does this change need documentation? What needs to be documented and how?

Status of this Pull Request

Proof of concept (not to be merged soon)

What is missing until this pull request can be merged?
Discussion

Checklist

Unrelated

@pljones
Copy link
Collaborator

pljones commented Jan 25, 2022

There are certain things that MUST be in the top level:

README.md
COPYING (or whatever we're calling our licence documentation)

Anything more than those two could live elsewhere, so long as README.md lists them and says where they are and what they're for.

@ann0see
Copy link
Member Author

ann0see commented Feb 2, 2022

Yes. I didn't move the README file.

@ann0see ann0see marked this pull request as ready for review February 3, 2022 18:08
@ann0see ann0see requested a review from gilgongo February 3, 2022 18:11
Copy link
Member

@hoffie hoffie left a comment

Choose a reason for hiding this comment

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

  • Should this get a changelog entry? It's a user-/contributor-visible change, so I'd say yes?
  • tools/create-translation-issues.sh needs updating wrt TRANSLATING.md
  • jamulussoftware/jamuluswebsite: README.md needs updating wrt TRANSLATING.md (separate PR as it's another repo)

@ann0see
Copy link
Member Author

ann0see commented Feb 5, 2022

Not sure if it's worth a change log entry. But we can, of course

@ann0see
Copy link
Member Author

ann0see commented Feb 5, 2022

CHANGELOG: Move documentation files into docs/ folder to clean up root folder.

Copy link
Member

@hoffie hoffie left a comment

Choose a reason for hiding this comment

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

Good to have this. Thanks! :)

@ann0see ann0see merged commit 970f2cd into jamulussoftware:master Feb 5, 2022
@ann0see ann0see deleted the f/moveDocs branch February 5, 2022 21:25
@ann0see
Copy link
Member Author

ann0see commented Feb 5, 2022

Seems as if the author information is lost due to the move.

@hoffie
Copy link
Member

hoffie commented Feb 5, 2022

What do you mean? git log? There's a git log --follow option, which should reveal the history, if this is what you mean?

@ann0see
Copy link
Member Author

ann0see commented Feb 5, 2022

I mean in the GitHub gui. It lists me as only contributor for the three files

@hoffie
Copy link
Member

hoffie commented Feb 5, 2022

Hm, too bad, but I don't think there's anything we could have done differently. Looks like Github lacks support for this, so I guess we'll have to live with it.

@ann0see
Copy link
Member Author

ann0see commented Feb 5, 2022

ok. so we'll need to live with it.

@pljones pljones added this to the Release 3.8.2 milestone Feb 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants