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

extend the docs #24

Open
bastelfreak opened this issue Jan 22, 2016 · 3 comments
Open

extend the docs #24

bastelfreak opened this issue Jan 22, 2016 · 3 comments

Comments

@bastelfreak
Copy link
Member

there are several new features and improvements that have been implemented in the last few days (see closed issues/PRs/new commits), we should update the README.md, also automatic doc generation would be fine.

@bastelfreak
Copy link
Member Author

will beimplemented in #32

@bastelfreak bastelfreak mentioned this issue Jan 28, 2016
@ghost
Copy link

ghost commented Feb 15, 2016

Things that are currently missing in the documentation:

  • tftp
  • pxelinux

This might be considered a no-brainer for an experienced sysadmin but to offer a complete documentation and make it possible for less experienced people to successfully set up marmoset, they should be mentioned.

Also the README.md currently mentions internal HEG URLs. The should be replaced with local API calls as in the other examples to be useful for someone setting marmoset up locally.

@bastelfreak
Copy link
Member Author

@heg-hpo I removed the URLs. I thought that the configuration of pxelinux und tftp is out ouf scope for this documentation, but I will think about adding it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant