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

docs: warn about flutter snap package #499

Merged
merged 7 commits into from
Jan 18, 2025

Conversation

2bndy5
Copy link
Contributor

@2bndy5 2bndy5 commented Jan 18, 2025

resolves #498

Changes

This replaces a footnote (about avoiding the flutter snap package) with an admonition and notes that app stores (at least on debian-based Linux distros) offer flutter SDK as a snap package.

@2bndy5
Copy link
Contributor Author

2bndy5 commented Jan 18, 2025

I see you've pushed some changes. The only one that I'd object to is using the same hyperlink target twice without taking advantage of Markdown's substitution mechanism.

But it's not my call to make...

@temeddix
Copy link
Member

I see your point. I was trying to match the formatting with that of other pages, but I think your method can also work.

I'll restore the link as per your suggestion :)

@2bndy5
Copy link
Contributor Author

2bndy5 commented Jan 18, 2025

I'm pretty good with mkdocs and Github Actions.

Using ReadTheDocs can allow a way preview docs changes in a PR without building the branch locally (see RTD docs for more detail)

I would also limit the other CI triggers to only run the workflow on relavent changes (see gitub docs for more detail). For example, it wouldn't make sense to run unit tests on changes that only affect the docs 😉 . Here, I think the test-app and example-app CI ran because of the addition to gitignore.

@temeddix
Copy link
Member

Currently, *.md files are excluded from the app build tests, but perhaps the .gitignore file can also be added to the list.

Any RTD-related PR is also welcome if it actually improves the workflow.

@temeddix temeddix merged commit 545b0e4 into cunarist:main Jan 18, 2025
22 checks passed
@2bndy5
Copy link
Contributor Author

2bndy5 commented Jan 18, 2025

Any RTD-related PR is also welcome

An admin for cunarist would have to import this repo into a RTD account (using Github credentials to sign in) and enable PR builds in the RTD project's settings. Afterward, it would be as simple as adding a .readthedocs.yml to tell RTD how to build the mkdocs project located in documentation/. No additional CI workflow needed.

@2bndy5 2bndy5 deleted the app-store-is-snap-pkg branch January 18, 2025 06:07
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

Successfully merging this pull request may close these issues.

Shouldn't install flutter from Linux distro's app store
2 participants