Skip to content

update and correct ood-portal-generator README.md #4740

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 4, 2025
Merged

update and correct ood-portal-generator README.md #4740

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions ood-portal-generator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
# ood-portal-generator

![GitHub Release](https://img.shields.io/github/release/osc/ood-portal-generator.svg)
![GitHub License](https://img.shields.io/github/license/osc/ood-portal-generator.svg)
This is part of the [ondemand](https://github.com/OSC/ondemand) repository

Generates an Apache configuration file that can be used for hosting an Open
OnDemand portal on the OnDemand Server.

For more information please visit the
[Documentation](https://osc.github.io/ood-documentation/master/infrastructure/ood-portal-generator.html).
[Documentation](https://osc.github.io/ood-documentation/latest/reference/commands/ood-portal-generator.html).

## Contributing

1. Fork it ( https://github.com/OSC/ood-portal-generator/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
1. [Fork the ondemand repository](https://github.com/OSC/ondemand/fork)
1. Create your feature branch (`git checkout -b my-new-feature`)
1. Commit your changes (`git commit -am 'Add some feature'`)
1. Push to the branch (`git push origin my-new-feature`)
1. Create a new Pull Request
Comment on lines +13 to +17
Copy link
Contributor

@johrstrom johrstrom Oct 31, 2025

Choose a reason for hiding this comment

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

Sorry! went to merge this and noticed this - seems like these steps should continue to be numbered 1 - 5.

Copy link
Contributor Author

@mrgum mrgum Nov 4, 2025

Choose a reason for hiding this comment

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

Hello.
In markdown ordered lists the numbers are incremented magically the numbers do not matter, using 1 makes it easier to insert an item to the list. https://www.markdownguide.org/basic-syntax/#ordered-lists

Copy link
Contributor

@johrstrom johrstrom Nov 4, 2025

Choose a reason for hiding this comment

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

You're right, I didn't look at the rendered file. That's so counter-intuitive!