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

Restructure guidelines chapter 3.7 for elaboration #990

Merged

Conversation

riedde
Copy link
Contributor

@riedde riedde commented Sep 15, 2022

The guidelines chapter 3.7 (Encoding Sources in MEI) lacks documentation. It only consists of two sections titlePage and foliation. Since the Metadata IG is working on that very big issue (started in 2020) many discussions were held and many suggestions for texts were made by members of the IG. This PR will be the first step in integrating the proposed texts into the MEI Guidelines.

This PR contains a detailed structure for chapter 3.7 (thematically organized sections and subsections) containing lists of elements for each section. It is not meant to leave it in this state! The element lists are a kind of placeholder that will be enriched with texts over time. A lot of those texts (i.e., proposals) have already been created by the IG and will be added in separate PRs. But before integrating the new structure must be applied.

In agreement with the administrative co-chairs of the technical team: This PR is opened to the branch ig-metadata. The IG will collect the work which is already done there. At a certain state a PR from the IG-branch to develop will be opened.

Co-authored-by: @music-encoding/ig-metadata

@github-actions github-actions bot added the Component: Guidelines & Documentation changes to source: docs, examples or web (assigned automatically) label Sep 15, 2022
@musicEnfanthen
Copy link
Member

Thanks for this enormous effort @music-encoding/ig-metadata . Will have a look at it, but give me some time, hopefully next week.

@riedde riedde requested review from ahankinson and musicEnfanthen and removed request for musicEnfanthen and ahankinson October 13, 2022 05:42
@musicEnfanthen
Copy link
Member

@ahankinson Do you mind to have another look?

Co-authored-by: Andrew Hankinson <andrew.hankinson@gmail.com>
Copy link
Member

@ahankinson ahankinson left a comment

Choose a reason for hiding this comment

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

Sorry, still needs a few changes.

riedde and others added 4 commits November 25, 2022 13:54
Co-authored-by: Andrew Hankinson <andrew.hankinson@gmail.com>
Co-authored-by: Andrew Hankinson <andrew.hankinson@gmail.com>
@riedde
Copy link
Contributor Author

riedde commented Jan 13, 2023

@ahankinson I did the asked changes, but I skipped those concerning the revision of the sections for "titlePage" and "foliation" (fixing typos is already done). Issues for revision of that are opened in the metadata-ig repo and your suggestions are linked to them. We will do that in a separate PR because this would take some time and we need the structure from this PR for implementing documentation snippets produced during the last 2 years. Can we handle it like this? This PR is against https://github.com/music-encoding/music-encoding/tree/ig-metadata and not develop, so there will be another review process!

@ahankinson
Copy link
Member

OK, since this is going to the ig-metadata branch I'll merge it!

@ahankinson ahankinson merged commit c0735fc into music-encoding:ig-metadata Jan 13, 2023
@ahankinson
Copy link
Member

Thanks all!

@riedde riedde deleted the restructure-guidelines-3.7 branch January 20, 2024 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Guidelines & Documentation changes to source: docs, examples or web (assigned automatically)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants