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.

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

Jump to bottom

Re-organize Configuration documentation #5501

Merged
merged 5 commits into from
Jan 13, 2022
Merged

Re-organize Configuration documentation #5501

merged 5 commits into from
Jan 13, 2022

Conversation

eaba
Copy link
Contributor

@eaba eaba commented Jan 12, 2022 •
edited by Aaronontheweb
Loading

Part fix for #5483

Changes

  • Moved ~/articles/hocon/index.md --> ~/articles/configuration/hocon.md

  • Moved ~/articles/concepts/configuration.md --> ~/articles/configuration/index.md

  • Moved ~/articles/configuration/* (all of the module-specific configurations) --> ~/articles/configuration/modules/*

Checklist

For significant changes, please ensure that the following have been completed (delete if not relevant):

@eaba
* Moved ~/articles/hocon/index.md --> ~/articles/configuration/hocon.md
a5a570b 
* Moved ~/articles/concepts/configuration.md --> ~/articles/configuration/index.md

* Moved ~/articles/configuration/* (all of the module-specific configurations) --> ~/articles/configuration/modules/*

* Moved
Aaronontheweb
Aaronontheweb requested changes Jan 12, 2022
View reviewed changes
Copy link
Member

@Aaronontheweb Aaronontheweb left a comment

Choose a reason for hiding this comment

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

Overall, it looks good to me but need to take care of that file capitalization issue and the toc.yml changes, similar to what we described here #5502

docs/articles/concepts/configuration.html
<meta http-equiv = "refresh" content="1;url=../configuration/index.html" />
</head>
<body>
<p>This page has been moved to <a href="../configuration/index.html">Akka.NET Configuration</a>.</p>
Copy link
Member

Choose a reason for hiding this comment

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

LGTM

docs/articles/configuration/toc.yml Outdated
@@ -1,12 +1,18 @@
- name: Index
Copy link
Member

Choose a reason for hiding this comment

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

LGTM

docs/articles/hocon/Index.html Outdated
@@ -0,0 +1,10 @@
<!DOCTYPE html>
Copy link
Member

Choose a reason for hiding this comment

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

Capitalization - this file will probably need to be lowercase index.html since we could be hosting on Linux.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it!

@Aaronontheweb
Copy link
Member

@eaba looks like the file name still isn't capitalized correctly - this is actually a big navigation problem on Linux systems.

This will help you: https://stackoverflow.com/questions/10523849/changing-capitalization-of-filenames-in-git

@eaba
Copy link
Contributor Author

eaba commented Jan 13, 2022

@eaba looks like the file name still isn't capitalized correctly - this is actually a big navigation problem on Linux systems.

This will help you: https://stackoverflow.com/questions/10523849/changing-capitalization-of-filenames-in-git

Please you confirm with the new commit?

@Aaronontheweb
Copy link
Member

It's still a problem. You might need to use wsl to make this change.

@Aaronontheweb Aaronontheweb enabled auto-merge (squash) January 13, 2022 13:52
@Aaronontheweb Aaronontheweb merged commit 7cce1a6 into akkadotnet:dev Jan 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Aaronontheweb Aaronontheweb Aaronontheweb approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@eaba @Aaronontheweb