build: 👷 add doc builds to github actions

[ChildishGiant]

Proposed changes

Added a workflow to compile and deploy the docs (Closes #71). For this example it's publishing to https://childishgiant.github.io/materialize Some of the links don't work as it goes to https://childishgiant.github.io but this won't be an issue if we set up a custom domain (one line change). This could also be fixed if we decide to stick with https://materializecss.github.io/materialize

I think there's an important question of what we do with parts of the docs such as the patreon sponsors and ads.

This is probably a licensing (and moral) issue so I'd greatly appreciate any thoughts on this

Checklist:

• I have updated the documentation accordingly.
• My change requires a change to the documentation.
• I have read the CONTRIBUTING document.
• All new and existing tests passed.
• I have added tests to cover my changes.

[ChildishGiant]

It's worth noting I did refactor the docs so it's all generated in the docs folder, not just chucked into the root. I've tried my best to make sure this has no negative impacts but if anyone is aware of any issues, please do let me know.

The action's currently failing for what seems to be an issue with the github bot account not having perms to push to this repo/org.

[Smankusors]

oh yeah about sponsors and ads, feel free to remove them. 😃

also @DanielRuf mentions there's tracker code on the code. But I haven't find it yet. The tracker should be removed, or changed to the new account that we manage.

[ChildishGiant]

Yea, there's google analytics too. I'll remove the ads, sponsors and tracking in this PR too.

[ChildishGiant]

There's also the question of what to do with the showcase, paid themes and support us pages. Personally I say we just remove them

[Smankusors]

There's also the question of what to do with the showcase. paid themes and support us pages. Personally I say we just remove them

I agree, feel free to remove them. About the support us page, that could be changed to contribute to this repository instead. (like helping with issues, create a good PR, etc.)

[wuda-io]

There's also the question of what to do with the showcase. paid themes and support us pages. Personally I say we just remove them

Fully agree with you. Awesome! This is getting better and better :)

[ChildishGiant]

Still need @DanielRuf to allow the bot to push (ideally before merging)
remote: Permission to materializecss/materialize.git denied to github-actions[bot].

[DanielRuf]

This is probably a licensing (and moral) issue so I'd greatly appreciate any thoughts on this

As they do not sponsor the new project, we can safely remove them. We do and did not receive any funding from them.

[DanielRuf]

also @DanielRuf mentions there's tracker code on the code. But I haven't find it yet. The tracker should be removed, or changed to the new account that we manage.

Google Analytics?

[DanielRuf]

Still need @DanielRuf to allow the bot to push (ideally before merging)

Not sure where / what needs to be done.

[Smankusors]

Not sure where / what needs to be done.

I think that's about allowing github-actions bot to push the commits to the gh-pages branch? Hmm is there any online documentation about this? @ChildishGiant

Google Analytics?

on the second thought..., do we.... currently need Google Analytics?

---

On the other hand, I do want to solve the .gitignore issue on this PR, but need to find some time to research it.

[wuda-io]

We should make GitHub Pages available and probably link to the gh-pages branch.

As @ChildishGiant said
This could also be fixed if we decide to stick with https://materializecss.github.io/materialize

[DanielRuf]

[ChildishGiant]

The source needs to be from / (root)

The docs have mixed messages about the permissions. I think this might solve the issue but if not we'll need to make a token with the right permissions.

I do want to solve the .gitignore issue on this PR

I've done what the creators of the action suggest, which is just deleting the rule from the gitignore in the deploy script. Us humans will still have the rule in place, like before.

do we.... currently need Google Analytics?

Personally I'm not overly interested in tracking our users 😉

[ChildishGiant]

This could also be an issue where it just doesn't have permissions because it's a PR, that would make a lot of sense now I think of it.

[DanielRuf]

The source needs to be from / (root)

Ok, I've updated it.

[DanielRuf]

This could also be an issue where it just doesn't have permissions because it's a PR, that would make a lot of sense now I think of it.

Right, secrets are not shared between forks and not available in PRs for good reasons.

[wuda-io]

Awesome Guys! The url is now working 🥳

[ChildishGiant]

Once this is merged the docs will be updated. I think everything is ready now: LGTM

[ChildishGiant]

What's stopping merge?

[ChildishGiant]

🎉 We could change this now 😉 If we get a custom domain I'll happily open a PR to sort that out too

[DanielRuf]

🎉 We could change this now 😉 If we get a custom domain I'll happily open a PR to sort that out too

Updated it to https://materializecss.github.io/materialize/ right now.

[boileaum]

You may update the "-- Browse the docs --" link in README.md accordingly.

[ChildishGiant]

You may update the "-- Browse the docs --" link in README.md accordingly.

Added to #90