search

ome / design

OME Design proposals
http://ome.github.io/design/
1 stars 15 forks source link

Move design documents into numbered directories #84

Closed rleigh-codelibre closed 6 years ago

manics commented 6 years ago

After this is merged would it be worth adding an index page and creating a gh-pages branch?

sbesson commented 6 years ago

:+1: for the index page (see https://github.com/openmicroscopy/design/pull/83#issuecomment-363841544). How would you see the gh-pages workflow working in terms of rendering of markdown pages, deployment URL and sync with the master branch?

hflynn commented 6 years ago

Does GitHub pages support building from a master branch now? I thought you didn't need to use gh-pages branches any more if you didn't have another reason for wanting that content on a separate branch

mtbc commented 6 years ago

Would it be worth suffixing the numbers with a brief title, "005-washing-the-dishes" or whatever? As it is you type "ls" and see no hint of into where to "cd". (Could then call the .md files just something standard instead of then repeating the title.)

manics commented 6 years ago

If you can publish straight off master that sounds fine to me

hflynn commented 6 years ago

https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/

sbesson commented 6 years ago

Looked into the various options for the discussion above. Publication is definitely doable using the master branch on GitHub with native support for Markdown rendering. Main issue is that this might force to rename the files as index.md - see http://sbesson.github.io/design/001/ for an example built on top of this branch.

Open questions:

On the second question, slight personal preference for the first option as this is the scheme used by other known communities, it makes slightly shorter URLs and defined code names (e.g. OME0001 ;) ) and allows us to update the title of a proposal without breaking published URLs. Other thoughts/rationale welcome.

rleigh-codelibre commented 6 years ago

The github.io URL seems fine; a CNAME in the DNS is a nice extra, but not essential.

Separate index.md files with a top-level index seems fine to me. Shall I do that in this PR?

sbesson commented 6 years ago

@rleigh-codelibre: feel free to push an additional commit as part of this PR as this also deals with renaming.

rleigh-codelibre commented 6 years ago

@sbesson Done. Please see https://rleigh-codelibre.github.io/design/ for a preview.

hflynn commented 6 years ago

Looks nice!

joshmoore commented 6 years ago

Very.

sbesson commented 6 years ago

Generally, very useful. Although the permanent URLs for these still remains to be defined/polished etc this refactoring provides very strong foundations to discuss/exposing some of these proposals to the wider community. Merging and we can decide on the RFEs separately.