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

design doc: add design doc #27

Merged
merged 1 commit into from
Aug 23, 2018
Merged

Conversation

ajeddeloh
Copy link
Contributor

@ajeddeloh ajeddeloh commented Aug 17, 2018

Accidently git push -d instead of git push -f on the other PR, which made it unopenable.

Please check for:

  • Grammar, clarity, etc
  • That I accurately recorded the discussion
  • Formatting seems good

I only did the partitioning issue. We can add summaries of other closed issues in more PRs.

I envision that when we want to close out an issue, we PR this doc with a summary. Once we agree the PR is good and accurately encapsulates the discussion, we merge the PR and close the issue.

As the doc grows we may want to break it out into multiple docs in a directory, but that can come later.

Finally, I'd prefer to keep this doc about design of FCOS itself and not about the process around it. We can have a seperate doc for that (the README does a great job right now) if we want.

Design.md Outdated

## Disk Layout

Originally discussed in issue #18
Copy link
Member

Choose a reason for hiding this comment

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

would be nice if this was a hyperlink to #18 - when I view it rendered it doesn't seem to auto hyperlink

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure, I thought it would autolink, but I guess not?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

Design.md Outdated
may not work with poorly implemeted UEFIs.
- What is the exact partition layout?
- Do we make /etc a ro bind mount?
- Do filesystem do we use for / and /var? ext4?
Copy link
Member

Choose a reason for hiding this comment

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

"What filesystem do we use"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oops. Fixed.

@ajeddeloh ajeddeloh force-pushed the add-design-doc branch 2 times, most recently from b16008f to 337927d Compare August 22, 2018 19:17
@dustymabe
Copy link
Member

LGTM

@dustymabe
Copy link
Member

anybody else want to review ?

@ajeddeloh
Copy link
Contributor Author

I'll give it a day and merge tomorrow unless someone else has other comments. SG? We should probably decide how we decide merge-readiness for these.

Copy link
Contributor

@bgilbert bgilbert left a comment

Choose a reason for hiding this comment

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

💯

Design.md Outdated
@@ -0,0 +1,41 @@
# Design Document

This document captures the design decisions made after dicussion in issues. When a design issue is closed, the
Copy link
Contributor

Choose a reason for hiding this comment

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

discussion

Design.md Outdated

### Summary:

- FCOS will use a "dd-able" image and ship with a standard parition layout.
Copy link
Contributor

Choose a reason for hiding this comment

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

partition

Add a document to record conclusions from dicsussions in the issues
section.
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