Re: Beam Website Feedback

[Ahmet Altay via dev <de...@beam.apache.org>]

Thank you Alex and Bulat for improving this. We all very much appreciate it.

On Thu, Dec 22, 2022 at 9:21 AM Alex Kosolapov <al...@akvelon.com>
wrote:

> Hi all,
>
>
>
> We were preparing some improvements for check-links.sh script that is used
> for testing Apache Beam website links during the website build with Bulat (
> @bullet03 <https://github.com/bullet03>).
>
>
>
> We saw several categories of link checks and error statuses:
>
>    - 404 - actual incorrect links - fixed in [1] and [2]
>    - Valid links that appear to the script as incorrect, e..g., 9xx
>    status code for LinkedIn requiring authentication in LinkedIn, some GitHub
>    documentation links, example links, some Meetup links, etc.
>
>
>
> We propose to add a “verified_list” to check_links.sh so that manually
> verified links can be skipped in testing. Current verified list includes 15
> links based on review of most recent test review. Inconvenience of this
> approach is that a verified link may become outdated, and would require an
> update of the “verified_list” in check_links.sh. This approach implemented
> in [3].
>
>
>
> [3] also contains check-links.sh improvements:
>
>    - Added a function that checks and reports Apache Beam staging website
>    links to prevent the production website from having links to staging
>    - Added script checks and reports Apache Beam website absolute links
>    (links of the form https://beam.apache.org/path) - relative links in
>    the sources are preferred to properly build and review website staging
>    - Added sorting any invalid links by their error code - this may be
>    more convenient for reviewing output
>
>
>
> [4] - optionally, update absolute links to relative links so that a
> staging website more closely resembles the production website
>
>
>
> We submitted [3] and [4] for PR review and tagged Alexey Romanenko to
> kindly help with reviewing these PRs. Please share your comments about
> proposed approach in the PRs or list.
>
>
>
> [1] https://github.com/apache/beam/pull/24635
>
> [2] https://github.com/apache/beam/pull/24744
>
> [3] https://github.com/apache/beam/pull/22221
>
> [4] https://github.com/apache/beam/pull/24747
>
>
>
> Thank you,
>
> Alex
>
>
>
> *From: *Rebecca Szper via dev <de...@beam.apache.org>
> *Reply-To: *"dev@beam.apache.org" <de...@beam.apache.org>, Rebecca Szper <
> rszper@google.com>
> *Date: *Wednesday, December 21, 2022 at 10:15 AM
> *To: *Ahmet Altay <al...@google.com>
> *Cc: *Alexey Romanenko <ar...@gmail.com>, dev <
> dev@beam.apache.org>, Rajkumar Gupta <ra...@google.com>
> *Subject: *[EXTERNAL] Re: Beam Website Feedback
>
>
>
> Our team doesn't maintain the Beam website infrastructure, but last time
> something like this came up, David said that there are consultants that
> work on this type of thing. He pinged @bullet03
> <https://github.com/bullet03> on the Beam ticket, who was able to help.
>
>
>
> On Tue, Dec 20, 2022 at 5:06 PM Ahmet Altay <al...@google.com> wrote:
>
>
>
>
>
> On Tue, Dec 20, 2022 at 1:12 PM Ahmet Altay <al...@google.com> wrote:
>
>
>
>
>
> On Tue, Dec 20, 2022 at 9:14 AM Alexey Romanenko <ar...@gmail.com>
> wrote:
>
> Thanks Ahmet! I’d prefer to fix the links as you did and add the redirect
> from old one - perhaps, there are other similar links that have been
> changed in the same way.
>
>
>
> Thank you for the review. I fixed it, and added a redirect too.
>
>
>
>
>
> Btw, I’m not sure that we still check the broken links as it was before,
> iirc, but probably it would be a good idea to add such check before
> publishing a website.
>
>
>
> I agree. I also do not know about the state of this. It would be good to
> add that links checker again.
>
>
>
> Adding @Rebecca Szper <rs...@google.com> - in case this is something she
> can fix or would know who could fix it.
>
>
>
>
>
>
>
> —
>
> Alexey
>
>
>
>
>
>
>
> On 20 Dec 2022, at 18:04, Ahmet Altay via dev <de...@beam.apache.org> wrote:
>
>
>
> I did a search and found a few places with the broken link. Correct links
> should be:
> https://beam.apache.org/get-started/resources/videos-and-podcasts/
>
>
>
> I created a PR to update the website (
> https://github.com/apache/beam/pull/24733). I do not know if that is the
> best solution. As an alternative we could consider setting up a redirect
> for the old link. We do not know who else would be still linking to the old
> one.
>
>
>
> Ahmet
>
>
>
> On Tue, Dec 20, 2022 at 8:52 AM Alexey Romanenko <ar...@gmail.com>
> wrote:
>
> Hi Rajkumar,
>
>
>
> Could you specify where (which page) this link was found?
>
> Thanks!
>
>
>
> —
>
> Alexey
>
>
>
> On 20 Dec 2022, at 10:08, Rajkumar Gupta via dev <de...@beam.apache.org>
> wrote:
>
>
>
> Hi Team,
>
>
>
> Just a minor point, while browsing the site I noticed that the link below
> is not working. Can you please check?
>
> https://beam.apache.org/documentation/resources/videos-and-podcasts
>
>
>
> Regards,
>
> Raj
>
>
>
> --
>
> Rajkumar Gupta | Technical Solutions Engineer - Google Cloud
> Platform | rajkumargupta@google.com <rf...@google.com> | +91-9223541460
> <+91%2092235%2041460>
>
>
>
>
>
>