kubernetes / contributor-site Goto Github PK
View Code? Open in Web Editor NEWCode for kubernetes.dev
Home Page: https://www.kubernetes.dev
License: Apache License 2.0
Code for kubernetes.dev
Home Page: https://www.kubernetes.dev
License: Apache License 2.0
We need to figure out how to use a search engine effectively for the site.
Some items are not rendered correctly with the sidebar and the top of the text being cut off at the top of the page.
Examples are the items listed under the resources category in the WIP Preview:
https://deploy-preview-122--kubernetes-contributor.netlify.com/resources/
This is blocking the general development of the docsy site conversion:
There is an issue between netlify and hugo with builds throwing this error:
Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss):
SCSS processing failed: file "stdin", line 6, col 1: File to import not found or
unreadable: ../vendor/bootstrap/scss/bootstrap
This has temporarily been resolved by committing the generated resources directory in the WIP Preview Branch, however this should be resolved before the general docsy branch is updated for others to
work off.
https://kubernetes-contributor.netlify.com/events/ is a blank page
Relative source URLs referencing external content are not being generated correctly.
Example:
CLA link from here:
https://kubernetes-contributor.netlify.com/guide/contributor-cheatsheet/#signing-the-cla
Original:
[cla]: /CLA.md#how-do-i-sign
After being imported:
[cla]: /CLA.md#how-do-i-sign
It should be expanded to reference the full github url below:
[cla]: https://github.com/kubernetes/community/blob/master/CLA.md#how-do-i-sign
/kind bug
/priority important-soon
/assign
The Code of Conduct link points directly to the code-of-conduct.md in the community repo. Is it possible to render that file in Hugo?
We should help the release team by making contributor.k8s.io/release a useful place.
Currently the release team uses a bit.ly link to point people to the right place. http://bit.ly/k8s112-release-info
Ideas for things to include on this page (please include more!):
For now, we can just make the URL autoforward to the right place on github so we can socialize it.
There need to be many minor changes and some neat upgrades on our website :
/kind design
/kind feature
/priority important-soon
Also wouldn't hurt to link to SIG calendar pages so they know where to update their calendar entries
/assign
The text on the welcome page is difficult to read. The background image has a mix of both bright and dark sections. The text is white and is difficult to read when it is over the brighter parts of the page.
This is a large restructure of the current project. Docsy is a hugo theme and very easy to extend.
The primary kubernetes website (https://kubernetes.io) is being converted to use the same backend theme. (preview).
It is also being used by minikube for their documentation (https://minikube.sigs.k8s.io) with a few other subprojects interested in using it as well.
For the contributor site a separate docsy branch has been made.
For a WIP preview: see this PR: #122 (site preview)
These are the issues that should be resolved before the docsy branch is promoted to master and becomes the default:
Google has recently announced the 2020 version of their Google Season of Docs (GSoD) program. CNCF has applied as an organization and is participating in the program - https://github.com/cncf/mentoring/tree/master/seasonofdocs.
According to the timeline, we have until 11 May to submit project ideas. I just wanted to get the issue created to track/start the conversation around this to check if we (contributor-site subproject) want to participate in it.
I missed this one, sig-release has a bunch of content that needs to be surfaced, it's not in k/community so we should find a way to integrate this, especially the security team stuff.
https://github.com/kubernetes/community/pull/2911/files#r232017450
The sidebar navigation should have only 4-5 options and have titles changed to more umbrella like topics.
Examples:
The Meet our Contributors page has this sentence:
Grab a copy of the calendar to yours from kubernetes.io/community
Something seems to be missing in that sentence.
I'm not sure what the intention was.
In addition, there's no calendar to be found at that site.
Happy to create a PR to just remove that sentence.
Hugo v0.60.0 introduced a new markdown renderer called goldmark. This new renderer is much closer to native GitHub flavored markdown which should eliminate some of the idiosyncrasies that have been seen with the current BlackFriday based rendering engine.
Goldmark and several other changes in v0.60.0+ may potentially introduce some breaking changes with the current site and should be evaluated with care.
/kind feature
have a green-yellow-red dashboard for new and current contributors to look for other sigs/wgs to join that may be actively recruiting more. sig/wg name - status light.
Green light would be tied to having good-first-issue and/or help-wanted labels
Yellow light would be tied just help-wanted (ie - likely better for casual and other contributors with experience)
Red light would be no use of either label
docsy has a different site layout than the previous contributor site generations. This will require restructuring the paths and titles (e.g. index.md
instead of _index.md
in some scenarios) of the things being ingested.
For reference, see the WIP preview.
how to get started/what sig do I join?,
mentoring opportunities, (source: survey, focus groups)
Taking from this doc and setting as an issue so we can close the doc down.
As seen from many documentations and contributors' sites, there is a need to provide Edit on GitHub
and Last Updated
link from the website document to the corresponding source of truth of doc.
/cc @mrbobbytables @parispittman
/priority important-soon
/kind feature
/assign
Some reference style links are not currently being detected by any of the sub_links regexes:
Example 1:
Reference link [Community Membership]
on kubernetes/community/README.md Currently points to https://contributor.kubernetes.io/community-membership.md
Example 2:
Reference link [OWNERS]
on kubernetes/community/community-membership Currently points to https://contributor.kubernetes.io/community-membership/contributors/guide/owners.md
Running a hosted 404 link checker or a CLI tool like linkchecker finds lots of 404's and out of date links on k/community.
We're going to need to sort out which ones are generator inflicted, and then which ones are just out of date/broken in the repo itself.
We should then come up with a plan to socialize how people can help fix/update these links. This should be tied into a new contributor ramp, these are fixes that would be useful to the community and are easy enough to onramp.
/kind feature
/priority important-soon
Supersedes #67
We need to figure out a way to ingest KEP metadata so that we can show open keps, keps that have been implemented, etc.
https://www.python.org/dev/peps/ wouldn't be a bad place to start inspiration-wise.
Most of the items in the events section should not be displayed here. How can we import a calendar feature? Could we generate a calendar from sigs.yaml since thats where they display the times/dates? The problem with that is hosts for those meetings won't be able to change their times if they cancel a meeting, reschedule, etc. We would also need a way to import contributor events not sig/wg meetings like the summit and meet our contributors.
can we pull in all of the changes that we are proposing and those that are landing in a contributor changelog - could use k-dev for this automation? could be a 'news' section and that's one of the sections. in a news area, could also pull in the chairs/tls email, any changes that are made to sigs.yaml (new groups, chairs, etc.).
All the pages using a youtube shortcode don't render content after the embedded video.
Taking from this doc and setting as an issue so we can close the doc down.
Now that we have a calendar working with different views switch like day, month, year in #99.
cc: @mrbobbytables @parispittman
/kind feature
/priority important-soon
https://contributor.kubernetes.io/special-interest-groups/sig-cluster-lifecycle/ is too much of a mouthful.
Some options for discussion:
Need to adjust the embedded youtube tag so it doesn't autowiden the video based on browser width.
Currently, external content is brought into the contributor-site via the hack/gen-content.sh bash script. In its original inception, it was quite small and lean -- but as a bash script usually does, it has grown to be unwieldy.
It'd be far better to replace it with a more supportable (and testable) means of bringing in external content. This means rewriting it something like go or python, or finding some other means of bringing in external content.
/kind feature
cc @vishakhanihore @nimbinatus
Need to add:
We turned these off on the contributor site because they are just a pile of markdown files with lots of broken links, etc. We'd need for these files to have frontmatter in order to render pretty.
https://kubernetes-contributor.netlify.com/events/meet-our-contributors/
Old video. Perhaps a youtube playlist would be better?
Info that needs to be surfaced for everyone.
Taking from this doc and setting as an issue so we can close the doc down.
A few sections for this one:
1 - introduction to the contributor ladder and owners files with a canonical link to the definitions
(this comes up several times throughout the content strategy doc; folks don't know what membership is, how to get to the next ladder, etc.)
2 - high level summary of mentoring we offer and links to fuller descriptions
3 - known teams (release, api reviewers, etc.)
4 - embed the contributor role board?
This link takes you off site. Is it possible to display an icon (e.g. https://icons8.com/icons/set/external-link) to denote that it's an external link?
Thanks @mauilion we have the kubernetes.dev domain ๐
This may need to be transferred over and managed via the k8s.io which will involve working with wg-k8s-infra
/kind feature
/priority important-soon
AIs
/assign
List of items that need to be resolved before go live. This may be updated as needed with further items as they're discovered.
Once all components are completed we will soft launch and share the link with the ContribEx mailing list. After 1 week if there are no issues, we will go live with the full launch and announce through general comms channels.
/milestone v1.19
/priority important-soon
/help wanted
For the first pass as we can see on https://kubernetes-contributor.netlify.com/guide/ , We have imported the complete Community/Contributor/Guide
directory. This may be a lot to digest for a new contributor who just wants to get started with his contributions. We must revamp the current Contributor Guide getting presented as on the website into much simpler and easy to navigate.
Some of the points:-
Additional Resources
which may redirect to contributor/guide
.Special thanks to @jberkus for collecting this information.
Mozilla - goodness included multiple paths for engagement including things like "follow us on twitter" which (AFAIC) are a lovely "stepping up" to contribution pathway; up-to-date events list; the "easy" interface here (https://www.mozilla.org/en-US/contribute/signup/); this page https://www.mozilla.org/en-US/firefox/channel/desktop/#beta (so friendly). The bad: this page (https://firefox-dev.tools/) is, I think, where the hardcore coders would start for instructions and it isn't as easy to find
Fedora -- they loved this! For a while it was impossible to find, but now it's linked nicely from the main getfedora page (yah!)
OpenMRS has a different approach in that the have a "How to contribute" book (http://devmanual.openmrs.org/en/) but I like it because it covers a lot of the non-dev-specific things like how they work and the project history in one place (this info is avail for many projects, but it's all spread out, so it is hard to know what things you should know before you start)
Ansible Pretty dense, but we've built up a fair amount of process over the
years. Getting the right people the right info can be a challenge;
this is our best attempt, and it's pretty much ever-evolving. New draft version
Gentoo has a 'Get involved' section which itself leads to https://gentoo.org/get-involved/contribute/that explains how one can contribute to the project. Note that we don't actually have a ton of core committers but receive significant contribution on our wiki and through our proxy maintainers project and the contribution web site is meant to detail different ways folks can get involved with the project besides just writing ebuilds.
At libreoffice.org take a look at the "Improve it" menu on the top navigation bar. We've recently revamped this section of the web site, which acts as an entry point to all the various places people can engage, including the DevCentral portal https://devcentral.libreoffice.org/ and the Developers area of our wiki https://wiki.documentfoundation.org/Development
FSFE has a page at https://fsfe.org/contribute/contribute.en.html which
we have overhauled just recently. Actually we've received quite positive
feedback about it, so it might help.
also node -> https://nodejs.org/en/get-involved/contribute/
Some projects that have "contributor profile" pages. This isn't something we've discussed before; is it something we'd want to do? There is a bit of a scale problem, of course:
Drupal
Including "people mentored", which is a way to encourage mentorship
Eclipse: https://projects.eclipse.org/projects/eclipse.jdt/who
Microprofile: https://microprofile.io/contributors/
PostgreSQL: https://www.postgresql.org/community/contributors/
Each page should generate a link in the footer that takes the user to the right page in the community repo to submit fixes/edits.
Netlify is aggressive with their cacheing of build dependencies. This can cause the cloned community repo to not be pulled as it is already there on disk.
Proposed Solution:
When executing out of a build context, perform a fetch/pull if the repo is already found on disk.
/assign
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.