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

[editorial] Ensure every section has a README #2558

Closed
7 tasks done
Tracked by #3739
chalin opened this issue May 19, 2022 · 2 comments · Fixed by #3936
Closed
7 tasks done
Tracked by #3739

[editorial] Ensure every section has a README #2558

chalin opened this issue May 19, 2022 · 2 comments · Fixed by #3936
Assignees
Labels
editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind.

Comments

@chalin
Copy link
Contributor

chalin commented May 19, 2022

Originally posted by @tigrannajaryan in #2479 (comment)

every section will need a README. I'm available to help here: e.g., I submit a first PR that adds a README (with only a title) to each section that doesn't have such a file. That'll act as a placeholder that can be built upon via subsequent PRs. WDYT?

Yes, sounds good. Some sub-directories have good candidates for README (e.g. most that have an "overview.md" should work as README).

Useful command:

$ find specification -type d '!' -exec test -e "{}/README.md" ';' -print | grep -v /img
@chalin
Copy link
Contributor Author

chalin commented Feb 1, 2024

Only one spec folder is without a README:

$ find specification -type d '!' -exec test -e "{}/README.md" ';' -print | grep -v /img
specification/logs/sdk_exporters
$ ls specification/logs/sdk_exporters
stdout.md

But given that it contains only one exporter, I think that it's ok for now to display the Stdout exporter under the Logs parent section.

So I'm going to mark this as done, finally! ✨

@chalin
Copy link
Contributor Author

chalin commented Mar 12, 2024

Changed my mind about the logs exporters folder, in particular because it'll be a quick workaround for the following Hugo 0.123.8 issue: Subpage missing from section's page list when using 0.123.8. Reopening.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants