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

Sample with node http-server #692

Open
wants to merge 2 commits into
base: v3
Choose a base branch
from

Conversation

salem84
Copy link

@salem84 salem84 commented Oct 6, 2020

Hi, I have created a sample configuration XML to start Node Http-Server, based on #605
I have added some comments to change default port and public folder

Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

Thanks for the pull request! Please address the license comment. It would be also great to somehow reference the file from documentation, e.g. by adding a "samples" section in the config xml documentation

<!--
MIT License

Copyright (c) 2008-2020 Kohsuke Kawaguchi, Sun Microsystems, Inc., CloudBees,
Copy link
Member

Choose a reason for hiding this comment

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

If you want to keep the license header, please update it so that it refers you or just WinSW Contributors + keep the right date. Also, IMHO the license header can be just deleted so that visitors see the actual content

Copy link
Author

Choose a reason for hiding this comment

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

I have copied from other samples, but I agree with you! it's better delete it

@salem84
Copy link
Author

salem84 commented Oct 8, 2020

It would be also great to somehow reference the file from documentation, e.g. by adding a "samples" section in the config xml documentation

Adding a bullet list table in samples paragraph in this page https://github.com/winsw/winsw/blob/v3/docs/developer/project-structure.md ?

Filename Description
sample-minimal.xml a template for mandatory configurations
sample-complete.xml contains all possible configurations with documentation
sample-shared-directory-mapper.xml a template to run a slave for Jenkins
sample-http-server.xml a template to run node http server

Or do you think it's better in another section?

@nxtn
Copy link
Contributor

nxtn commented Dec 8, 2020

Adding a bullet list table in samples paragraph in this page https://github.com/winsw/winsw/blob/v3/docs/developer/project-structure.md ?

Would be better to add a README.md with this table in the samples directory. The "filename" column could be replaced with display names.

@nxtn nxtn added this to the 3.x milestone Dec 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants