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

feat: Update Pre-Built Configuration Files Pages #18

Merged
merged 4 commits into from
Feb 8, 2024
Merged

feat: Update Pre-Built Configuration Files Pages #18

merged 4 commits into from
Feb 8, 2024

Conversation

yammes08
Copy link
Contributor

@yammes08 yammes08 commented Jan 7, 2024

This pull request seeks to provide additional information on the deployment and usage of pre-built configuration files. Both Wiki pages for these have been updated to provide clarity on:

  • Deployment
  • Usage
  • Limitations
  • Customization

Links to other relevant parts of the Wiki have also been provided.

- Add more substantial information on the deployment and usage of config templates
- Lint fixes
- Fix list layout issue under Deployment
- Apply consistent Americanized spelling
@rcdailey
Copy link
Member

rcdailey commented Jan 7, 2024

I'm not a huge fan of having duplicated documentation. How would you feel about moving that to its own page and linking to it (with some short blurbs) from the 2 pages you changed?

@yammes08
Copy link
Contributor Author

yammes08 commented Jan 8, 2024

Howdy. More than happy for these updates to go wherever you think is most appropriate. Maybe what we could do is agree on which bits represent duplications, and then have a new 'QuickStart' page instead?

@rcdailey
Copy link
Member

rcdailey commented Jan 8, 2024

Might be good to try something like this: eclipse-tractusx/eclipse-tractusx.github.io#373 (comment)

This way, we can inline the content on the two pages (just like you have) but keep the actual text in a single file so it can be centrally updated.

I haven't used this feature before, but if you'd like to experiment with it, please go ahead. Otherwise I'll try to do this for you when I get some time. Sorry I can't help more; I've been really busy the past couple of days.

Copy link
Member

@rcdailey rcdailey left a comment

Choose a reason for hiding this comment

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

Yammes, thank you for the changes. I did add a bit on top of what you did in order to reduce duplication, but the content should be the same. If you have any feedback please let me know; always happy to open future PRs for more adjustments if needed.

@rcdailey rcdailey merged commit f8a9c74 into recyclarr:master Feb 8, 2024
3 checks passed
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.

2 participants