search

commontype-standard / commontype

Annotated OpenType Specification
Other
23 stars 1 forks source link

Clarify role of `master` and `source` #15

Closed twardoch closed 3 years ago

twardoch commented 3 years ago

I’m confused about the roles of the master and source branches. I propose to put the “old” AOTS stuff into a branch named original or archive, and forget about it once and for all, and in the working branch (master), keep only Markdown files, the stuff to build the website, but forget about the Java and old XML stuff. @simoncozens agree?

simoncozens commented 3 years ago

No, no! That's not what it's about. Because this is hosted as a Github "user page", gh-pages needs the HTML to be in the master branch. So that can't be renamed. The source branch is the markup that we edit to produce the HTML, and that source is in XML.

I may be in a minority but I think having it in XML is pretty useful for a variety of reasons: repurposing for different output formats, and being able to programmatic select portions of the output (e.g. with/without test suites; with/without sample implementation; with explanatory notes or just the bare formal spec).

graphicore commented 3 years ago

Github "user page", gh-pages needs the HTML to be in the master branch. So that can't be renamed.

It's possible in the GitHub Repository settings to change the branch GitHub Pages uses.

khaledhosny commented 3 years ago

The options are limited, but you can make a gh-pages branch and use it, which would be less confusing than master.

chrissimpkins commented 3 years ago

You can also use a docs directory in the master branch. Here are the GH Pages configuration docs.

simoncozens commented 3 years ago

In general, this is is true. But if it is a page for your user account (in this case commontypestandard.github.io), you must use the master branch.

Screenshot 2020-07-28 at 14 23 14

I suppose the obvious step would be to rename the repo so it isn't the user page; that should enable us to still host it on commontype.org. I'll see if I can work it out.

simoncozens commented 3 years ago

OK, I think that's got it - renamed to "commontype" (I feel a bit weird about standard vs. specification anyway), moved everything from old-master to docs/ on new master, merged source into master, and got rid of source branch.

twardoch commented 3 years ago

OK, I fixed some links in readme, will fix more