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

Add initial content for explanation/merges and syncs #53

Open
wants to merge 8 commits into
base: 2.0-preview
Choose a base branch
from

Conversation

dviererbe
Copy link
Collaborator

This PR adds the initial content for the explanation of syncs and merges from Debian unstable.

@dviererbe dviererbe added the documentation Improvements or additions to documentation label May 2, 2024
@dviererbe dviererbe added this to the 2.0 Release milestone May 2, 2024
@dviererbe dviererbe requested review from rkratky and s-makin May 2, 2024 15:28
@dviererbe dviererbe self-assigned this May 2, 2024
@dviererbe
Copy link
Collaborator Author

I looked through the CI errors:

  • synchronization is marked as a spelling error. Most likely, because it wants it to be written as synchronisation 🙄
  • The refs DebianImportFreeze, FeatureFreeze, FinalRelease, etc. are not defined, because the follow up PR Add initial content for explanantion/development process #54 does it. This also causes spell checking errors.
  • Link check times out for https://merges.ubuntu.com/*. The long loading time for Merge-o-Matic is expected behavior. Maybe we should add a linkcheck ignore. Not ideal, but acceptable for me. We could also look into massively increasing the timeout time. Don't know what the value should be so that it is not flaky.
  • The spelling checker also does not like the "Matic" of "Merge-o-Matic" and its acronym "MoM". This should be easily fixable.
  • The manpages.ubuntu.com linkckecks are marked as 404 broken, but i can not figure out why. They work for me in a browser.

@s-makin
Copy link
Collaborator

s-makin commented May 2, 2024

* Link check times out for `https://merges.ubuntu.com/*`. The long loading time for Merge-o-Matic is expected behavior. Maybe we should add a linkcheck ignore. Not ideal, but acceptable for me. We could also look into massively increasing the timeout time. Don't know what the value should be so that it is not flaky.

I would agree with adding it to the linkcheck ignore. I think that would be better than increasing the timeout time, otherwise people working on PRs or making contributions will end up having frustrating experiences with the tests.

* The `manpages.ubuntu.com` linkckecks are marked as 404 broken, but i can not figure out why. They work for me in a browser.

I was having the same issue with manpages.ubuntu.com links in Pro docs. I couldn't see any legitimate reason for it, and the links were working when I clicked on them. I'd be a bit more hesitant about adding that to linkcheck ignore though, since there might be genuinely broken pages among those, which we will want to at least be prompted to check.

@dviererbe
Copy link
Collaborator Author

dviererbe commented May 2, 2024

I'd be a bit more hesitant about adding [manpages.ubuntu.com] to linkcheck ignore though, since there might be genuinely broken pages among those, which we will want to at least be prompted to check.

Fully agree, but I also do not know how to proceed here. Manually checking links every time can't be the solution :/

Merge-o-Matic has a long loading time that is erroneously
marked as broken, because of linkcheck timeouts.

Additionally, loading Merge-o-Matic is sometimes flaky.
@dviererbe dviererbe force-pushed the explanation/merges-and-syncs branch from 9067773 to 36624cb Compare May 2, 2024 16:36
@dviererbe
Copy link
Collaborator Author

I'd be a bit more hesitant about adding [manpages.ubuntu.com] to linkcheck ignore though, since there might be genuinely broken pages among those, which we will want to at least be prompted to check.

Fully agree, but I also do not know how to proceed here. Manually checking links every time can't be the solution :/

suggestion: I could write a script that greps all :manpage:`value` and check it with curl and tell linkcheck to ignore manpage.ubuntu.com.

@dviererbe
Copy link
Collaborator Author

dviererbe commented May 3, 2024

I through together this script. It even has the benefit of de-duplicating manpage checks.

#!/usr/bin/env bash

manpages=$(grep \
    --basic-regexp ':manpage:`.\+`' \
    --only-matching \
    --recursive --include '*.rst' docs \
    | cut --delimiter '`' --fields 2 \
    | sort --unique)
    
pass=true

for manpage in $manpages
do
    # assuming the pattern "PAGE(SECTION)"
    page="${manpage%%(*}"
    section="${manpage#*(}"
    section="${section%)*}"

    url="https://manpages.ubuntu.com/manpages/en/man${section}/${page}.${section}.html"

    if curl --silent --show-error $url > /dev/null
    then
        echo "INFO: Tested $manpage successfully (URL='$url')."
    else
        pass=false
        echo "ERROR: Failed to load manpage $manpage (URL='$url')."
    fi
done

if $pass
then
    echo "PASS: All manpages were accessible."
else
    echo "FAIL: One or more manpage(s) did not load properly."
    exit 1
fi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants