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

Replace README with README.md #12

Merged
merged 4 commits into from
Dec 20, 2013
Merged

Replace README with README.md #12

merged 4 commits into from
Dec 20, 2013

Conversation

mvidner
Copy link
Member

@mvidner mvidner commented Nov 5, 2013

Continuing the series from #9.

It is not intended to be merged but

  • to continue a discussion about how YaST module README.md files should generally look like
  • to give @jreidinger a template to base yast2-installation/README.md on ;-)


Before submitting any change please read our [contribution
guidelines](CONTRIBUTING.md).

Copy link
Member

Choose a reason for hiding this comment

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

I miss here links to possible developer documentation living in module like own agent or some design document. Where it should go?

Copy link
Member Author

Choose a reason for hiding this comment

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

I added (linked) it above in the Documentation section.

@mvidner
Copy link
Member Author

mvidner commented Dec 18, 2013

OK, so the remaining things for this one are

  • replace A B C with the actual features
  • make a section/link for module-specific developer documentation (there is some outdated docs, but removing it is out of scope here)

I will do it this week

@mvidner
Copy link
Member Author

mvidner commented Dec 20, 2013

I hope this is finally ready for merge, after a long delay on my part. @dmajda @jreidinger OK?

@jreidinger
Copy link
Member

Looks good to me

mvidner added a commit that referenced this pull request Dec 20, 2013
Replace README with README.md
@mvidner mvidner merged commit bf11cc0 into master Dec 20, 2013
@mvidner mvidner deleted the readme-draft-3 branch December 20, 2013 15:28
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.

None yet

3 participants