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

Update README to point to new site #261

Merged
merged 3 commits into from
May 24, 2021
Merged

Update README to point to new site #261

merged 3 commits into from
May 24, 2021

Conversation

jmertic
Copy link
Contributor

@jmertic jmertic commented May 11, 2021

Signed-off-by: John Mertic jmertic@linuxfoundation.org

Signed-off-by: John Mertic <jmertic@linuxfoundation.org>
@jmertic jmertic mentioned this pull request May 11, 2021
Copy link
Contributor

@jfpanisset jfpanisset left a comment

Choose a reason for hiding this comment

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

More generally, the substance of README.md has been moved to index.md, but someone landing on the repo will now just see:
https://github.com/AcademySoftwareFoundation/tac/tree/jmertic-patch-7
which is somewhat surprising: typically when you navigate to a GitHub repo, you expect the README.md to present the overview material for the repo. Does the home page for the netlifyed version have to be in index.md, or could it come straight from README.md, like a GitHub Pages jekyll site?

Also, the sections:

  • Meetings and Conversations
  • Conference Call Details

that were in README.md are not in index.md, is this desired? Or did that information migrate somewhere else?

README.md Outdated

The role of the Technical Advisory Committee (TAC) of the Academy Software Foundation (ASWF) is to facilitate communication and collaboration among the Technical Projects. The TAC will be responsible for:
# Academy Software Foundation Techincal Advisory Council (TAC)
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: "Technical", not "Techincal"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The bane of my spelling challenges - thank you :-)

Signed-off-by: John Mertic <jmertic@linuxfoundation.org>
@jmertic
Copy link
Contributor Author

jmertic commented May 12, 2021

More generally, the substance of README.md has been moved to index.md, but someone landing on the repo will now just see:
https://github.com/AcademySoftwareFoundation/tac/tree/jmertic-patch-7
which is somewhat surprising: typically when you navigate to a GitHub repo, you expect the README.md to present the overview material for the repo. Does the home page for the netlifyed version have to be in index.md, or could it come straight from README.md, like a GitHub Pages jekyll site?

It's a good question; the challenge is now we a generating parts of that page as part of the Netlify build ( you can see all the tags in there ) so it likely won't look right. I could see over time further divergences, so directing people to the display site is likely where we'd want to go here. But I'm open to direction for the community - so let me know if we should go a different route.

Also, the sections:

  • Meetings and Conversations
  • Conference Call Details

that were in README.md are not in index.md, is this desired? Or did that information migrate somewhere else?

That moved under meetings/README.md

@jfpanisset
Copy link
Contributor

Looks good, just learned that the C in TAC stands for Council and not Committee.

@jmertic
Copy link
Contributor Author

jmertic commented May 24, 2021

Looks good, just learned that the C in TAC stands for Council and not Committee.

Yep! https://github.com/AcademySoftwareFoundation/foundation/blob/master/CHARTER.md#7--technical-advisory-council

@jmertic jmertic merged commit 078386a into main May 24, 2021
@jmertic jmertic deleted the jmertic-patch-7 branch May 24, 2021 10:42
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