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

Thoroughly test site on phone #6

Open
mjeronimo opened this issue Nov 7, 2022 · 5 comments
Open

Thoroughly test site on phone #6

mjeronimo opened this issue Nov 7, 2022 · 5 comments
Assignees

Comments

@mjeronimo
Copy link
Contributor

The Space ROS website should be tested on a phone to ensure that the site is properly responsive and works well using the smaller form factor.

@mjeronimo
Copy link
Contributor Author

I was playing around with the site on my older iPhone and noticed that the header mentions "Rolling":

iphone

I see that there is a section in conf.py that specifies the distro:

distro_full_names = {
    'humble': 'Humble Hawksbill',
    'rolling': 'Rolling Ridley',
}

# These default values will be overridden when building multiversion
macros = {
    'DISTRO': 'rolling',
    'DISTRO_TITLE': 'Rolling',
    'DISTRO_TITLE_FULL': 'Rolling Ridley',
    'REPOS_FILE_BRANCH': 'main',
}

I assume we should change this to Humble since that's our current basis, but I'm not sure how all of these macros are used on the site. Worth a look...

@german-e-mas
Copy link
Contributor

german-e-mas commented Dec 7, 2022

This is from the Docs, right? The website link to the docs goes to https://space-ros.github.io/docs/rolling/index.html, perhaps we need to change it to https://space-ros.github.io/docs/humble/index.html ? (note, it's a 404). We don't have those macros in the website.

In the website, the appearance of rolling is only on links to the docs, on the hero page and the getting started page.

@german-e-mas
Copy link
Contributor

On a sidenote, on my cellphone I see a 1px wide white column at the left of the hero images. It's very annoying and should be fixed.

It is related to the sidenav I believe. Which also needs to be fixed: Opening should cover all the page on mobile devices.

@mjeronimo
Copy link
Contributor Author

Hmm. It's a bit confusing. The link you provided is correct. It is to the 'rolling' branch of the space ros docs (not to be confused with the Rolling release of ROS 2). However, the other macros mentioned refer to the ROS 2 version of the doc site (which is normally used for a ROS 2 release and not a special thing like Space ROS). So, I think we want to change the macros to refer to Humble (since Space ROS is currently based on Humble), but keep the website link as https://space-ros.github.io/docs/rolling/index.html.

@nuclearsandwich - any input on this?

@nuclearsandwich
Copy link
Contributor

nuclearsandwich commented Dec 7, 2022

When we started the docs site Space ROS was based on ROS 2 Rolling. Now that we've transitioned to Humble we need to determine how to handle the docs site. The purpose of the Sphinx multibranch plugin is to allow ROS documentation to be maintained independently for multiple supported distributions. But there is currently only one supported distribution of Space ROS.

Some things to consider:

  • Short term it wouldn't be my recommendation to return to a Rolling-based Space ROS due to the added volatility of Rolling during a time of low maintenance for Space ROS itself. Stuff will break and we won't have enough time to fix it compared to running based on a stable base.
  • Where the allocator work lands could affect the desired Space ROS base in the medium term.
  • Long term it's quite likely that Space ROS may move to Rolling/Iron in order to leverage further improvements.

No version of Space ROS is currently in a long term support phase and I think that it makes sense to focus Space ROS moving forward on newer distributions until there are projects using a specific Space ROS release, at that point we can work with those teams to figure out what their integration model is and how aggressively they're pulling in features from later ROS distributions in regardless of their compatibility with the distribution their initial version of Space ROS is based on.

This is a bit of digression into Space ROS's versioning and release plans but I think that what we do for the docs will largely be driven by what we do for Space ROS.
In the immediate term, let's keep working on the Rolling branch. Once we know where that we can stay on Humble for the upcoming phase of Space ROS development it will make sense to set up the Humble branch of the docs site as a duplicate of the current rolling docs and then switch the defaults and put up a "⚠️ deprecated" sign on the Rolling docs stating that Humble is the currently supported Space ROS release. If we dust off a Rolling-based Space ROS again in the future we'll update the Rolling docs site to accompany it.

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

No branches or pull requests

3 participants