Skip to content

[BEAM-11424-11423-11368][Website revamp] Implemented contribution guide, become a committer pages and twitter feed - #13565

Merged
TheNeuralBit merged 39 commits into
apache:website-revampfrom
PolideaInternal:website/contribute-twitter
Feb 5, 2021
Merged

[BEAM-11424-11423-11368][Website revamp] Implemented contribution guide, become a committer pages and twitter feed #13565
TheNeuralBit merged 39 commits into
apache:website-revampfrom
PolideaInternal:website/contribute-twitter

Conversation

@Jakub-Sadowski

Copy link
Copy Markdown
Contributor

Implemented:

  • contribution guide page
  • become a committer page
  • twitter feed component

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Choose reviewer(s) and mention them in a comment (R: @username).
  • Format the pull request title like [BEAM-XXX] Fixes bug in ApproximateQuantiles, where you replace BEAM-XXX with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

Post-Commit Tests Status (on master branch)

LangSDKDataflowFlinkSamzaSparkTwister2
GoBuild Status---Build Status---Build Status---
JavaBuild StatusBuild Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build StatusBuild Status
Build Status
Build Status
Build Status
PythonBuild Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
---Build Status---
XLangBuild StatusBuild StatusBuild Status---Build Status---

Pre-Commit Tests Status (on master branch)

---JavaPythonGoWebsiteWhitespaceTypescript
Non-portableBuild StatusBuild Status
Build Status
Build Status
Build Status
Build StatusBuild StatusBuild StatusBuild Status
Portable---Build Status------------

See .test-infra/jenkins/README for trigger phrase, status and link of all Jenkins jobs.

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests

See CI.md for more information about GitHub Actions CI.

@Jakub-Sadowski

Copy link
Copy Markdown
ContributorAuthor

Review: @TheNeuralBit

@pabloem
pabloem self-requested a review December 17, 2020 17:27
@pabloem

Copy link
Copy Markdown
Member

thank you @Jakub-Sadowski ! Can you share a few screenshots of these changes?

@TheNeuralBit

Copy link
Copy Markdown
Member

@pabloem

Copy link
Copy Markdown
Member

ouch - thanks Brian!

@TheNeuralBit

Copy link
Copy Markdown
Member

No worries :) I can still review this one if that's ok with you, I'll have time this afternoon

@pabloem

pabloem commented Dec 17, 2020 via email

Copy link
Copy Markdown
Member

@TheNeuralBitTheNeuralBit left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm concerned that this makes a lot of changes to the actual markdown content, like website/www/site/content/en/contribute/become-a-committer.md and website/www/site/content/en/contribute/_index.md

These are exactly the sort of changes we're trying to avoid making as part of the website revamp because they're impossible to deconflict with any website updates that happen in parallel in master.

In general this PR has two types of changes in these content files:

  1. Changes just to make the page render correctly (e.g. adding <div> and <br> tags)
  2. Changes to the actual content (re-wording or re-arranging text)

We should try very hard to avoid (1), and keep the content separate from the template that renders it.

(2) should be done on the master branch, with the existing website.

If we adhere to both of those, there won't be the need to make markdown changes in the website-revamp branch

Comment threadwebsite/www/site/content/en/contribute/_index.md Outdated
Comment threadwebsite/www/site/content/en/contribute/become-a-committer.md
@Jakub-Sadowski

Copy link
Copy Markdown
ContributorAuthor

Review: @kgabryje

Comment threadwebsite/www/site/assets/scss/_calendar.scss
Comment threadwebsite/www/site/assets/scss/lists.scss Outdated
Comment threadwebsite/www/site/content/en/contribute/_index.md Outdated

@TheNeuralBitTheNeuralBit left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I just synced master into the website-revamp branch and there's now a conflict with contribute/_index.md. This is probably because of #13420 which made substantial changes to that file.

Comment threadwebsite/www/site/content/en/contribute/_index.md
Comment threadwebsite/www/site/content/en/contribute/_index.md
Comment threadwebsite/www/site/content/en/contribute/_index.md
Comment threadwebsite/www/site/content/en/contribute/_index.md Outdated
Comment threadwebsite/www/site/content/en/contribute/_index.md Outdated

@TheNeuralBitTheNeuralBit left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This PR makes a lot of seemingly unnecessary changes to existing content files (blog posts, documentation, and programming guide). Some of them are benign, like changing ``` to {{< highlight >}}, but there also substantive ones like removing leading whitespace from code samples.

Even the benign ones present an issue, because they are surely going to cause merge conflicts, and they make this into an 8k line PR, which is very difficult to review. Please revert these changes.

Comment threadwebsite/www/site/content/en/blog/adding-data-sources-to-sql.md Outdated

@TheNeuralBitTheNeuralBit left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

A few more notes here, but again, I haven't looked it all over yet because It's very challenging to review just the substantive changes amid all the changes to the code blocks.

Comment threadwebsite/www/site/data/en/ways_of_contribution.yaml Outdated
Comment threadwebsite/www/site/layouts/shortcodes/highlight.html Outdated

@TheNeuralBitTheNeuralBit left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks it looks like a lot of the extra changes have been reverted, but there are still a lot remaining. It would be great if we could keep the original {{< highlight lang >}} syntax and avoid having to change the existing content altogether.

Comment threadwebsite/www/site/content/en/blog/adding-data-sources-to-sql.md Outdated
Comment threadwebsite/www/site/content/en/blog/beam-2.22.0.md Outdated
Comment threadwebsite/www/site/content/en/contribute/practises.md Outdated
Comment threadwebsite/www/site/content/en/contribute/practises.md

@Jakub-SadowskiJakub-Sadowski left a comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

done

Comment threadwebsite/www/site/content/en/contribute/practises.md
Comment threadwebsite/www/site/layouts/shortcodes/highlight.html Outdated
Comment threadwebsite/www/site/layouts/shortcodes/highlight.html Outdated
Comment threadwebsite/www/site/content/en/contribute/_index.md
Comment threadwebsite/www/site/content/en/contribute/_index.md Outdated
Comment threadwebsite/www/site/content/en/contribute/_index.md
Comment threadwebsite/www/site/content/en/contribute/_index.md
Comment threadwebsite/www/site/content/en/contribute/_index.md
Comment threadwebsite/www/site/content/en/contribute/_index.md

@TheNeuralBitTheNeuralBit left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ok a few last comments here. I think this is ready to go if we get all these addressed.

Comment threadwebsite/www/site/content/en/contribute/_index.md Outdated
Comment threadwebsite/www/site/content/en/contribute/_index.md
Comment threadwebsite/www/site/data/en/committer_traits.yaml Outdated
el.value=text;document.body.appendChild(el);
el.select();document.execCommand('copy');
document.body.removeChild(el);
alert('copied to clipboard');

@TheNeuralBitTheNeuralBitFeb 4, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This alert is strange to me. It's weird to have to click "OK" after copying.

Other implementations of this sort of featureu usually pop up a notification to let you know the content has been copied, but you don't have to acknowledge it. If it's too much to address this right now let's file a jira about it.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

From fastest ways I can change it to pop up under a button, but then there would be no popover when user hover on an icon

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ok let's just file a jira for now

Comment threadwebsite/www/site/layouts/shortcodes/highlight.html Outdated
Co-authored-by: Brian Hulette <hulettbh@gmail.com>

@TheNeuralBitTheNeuralBit left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, thank you!

@TheNeuralBit
TheNeuralBit merged commit a566b4e into apache:website-revampFeb 5, 2021
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@Jakub-Sadowski@pabloem@TheNeuralBit@griscz@kgabryje