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

spec: split up sections to separate .md files #62

Closed
SteveLasker opened this issue May 12, 2019 · 6 comments
Closed

spec: split up sections to separate .md files #62

SteveLasker opened this issue May 12, 2019 · 6 comments

Comments

@SteveLasker
Copy link
Contributor

The distribution spec currently has greater than 4,500 lines. Attempting to find or edit a section becomes a tedious task.

Issue is to break the spec up into logical units, similar to the image-spec.

@vbatts
Copy link
Member

vbatts commented May 13, 2019 via email

@jzelinskie
Copy link
Member

jzelinskie commented May 16, 2019 via email

@SteveLasker
Copy link
Contributor Author

I’ll make a TOC proposal for review, before making a split up PR

@SteveLasker
Copy link
Contributor Author

SteveLasker commented May 20, 2019

As I started to consider a new TOC, I wondered what opinions were on links to the current spec, including anchors.
Before I make a new TOC proposal, would some block is it could break links like: https://github.com/opencontainers/distribution-spec/blob/master/spec.md#initiate-blob-upload
I suppose I could put a list of headings in the footer as forwarders

Link Cross Refernece

Initiate Blob Upload

moved here

@jonjohnsonjr
Copy link
Contributor

As long as the split makes sense; I find that the image spec's layout is suboptimal because it jumps across files and sometimes has cyclic references.

I tend to agree. GitHub's search is... not great, so splitting across pages makes it nearly impossible to find anything. Right now I can just Ctrl+F within the page.

@vbatts
Copy link
Member

vbatts commented Apr 1, 2020

lets not split up just now. Instead lets look at the reorg #126

@vbatts vbatts closed this as completed Apr 1, 2020
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

No branches or pull requests

4 participants