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

Implement togglable GitLab content & add GitLab intro #186

Closed
wants to merge 14 commits into from

Conversation

unode
Copy link
Contributor

@unode unode commented Feb 3, 2021

This pull request adds the HTML/CSS/JS bits to allow
toggling between GitHub and GitLab content.

Currently only the introduction has (some) dual content.
I'll include the GitLab introduction in this pull request.
Will be adding the equivalent steps from GitHub and a GitLab specific section referencing how to configure GitLab for Jekyll.

When building locally the GitHub/GitLab selector will allow selecting both simultaneously for easier editing.
In GitHub Pages builds only one will be shown at a time.

On local builds GitHub and GitLab content will have a light blue or light orange background, respectively.
No background will be set on GitHub Pages builds.

@unode
Copy link
Contributor Author

unode commented Feb 3, 2021

The Intro isn't complete yet but feedback is welcome on how the content is displayed.

I ended up going for something different from the tabbed sections we discussed.
I found that the tabs used in the unix lesson e.g. in the setup section forced either one big tab with alternative content or too many interruptions in the content flow with several smaller tabbed sections, making it visually disruptive.

The current approach makes alternating between Git[La|Hu]b content unnoticeable. I'm currently using a CSS debug feature to visually distinguish the two.

@unode unode force-pushed the gitlab-github-switch branch from 26f16e0 to c687842 Compare February 4, 2021 23:43
@unode unode mentioned this pull request May 14, 2021
@unode unode force-pushed the gitlab-github-switch branch from 4fa3b25 to 90612e9 Compare May 15, 2021 00:06
@unode unode marked this pull request as draft May 16, 2021 05:32
@unode unode changed the title WIP Implement togglable GitLab content & add GitLab intro Implement togglable GitLab content & add GitLab intro May 16, 2021
@unode unode force-pushed the gitlab-github-switch branch 3 times, most recently from 62d76f8 to dce83c5 Compare May 16, 2021 22:12
@unode
Copy link
Contributor Author

unode commented May 16, 2021

This is rebased on #247 to avoid some merge conflicts.
Will also need to be rebased on #246 once that PR receives final approval.

Marking this feature beta and providing beta GitLab content for Introduction and alpha for "Authoring Markdown"
Will follow with GitLab Pages intro by which this would be ready for a first merge.

@unode unode mentioned this pull request May 16, 2021
unode added 14 commits May 17, 2021 19:17
This code does 2 things:
1. Toggles <articles> with ids that start with github- and gitlab- to
hide/show either of the two.
2. Stores and reads a parameter from the URL to override and persist the
GitHub/GitLab widget selection across pages (without client-side data)
If set to false, only GitHub or GitLab content can be displayed.
If set to true, both contents will be displayed one after the other.
Additionally, if true, GitHub and GitLab specific content will have a
distinctive background taint for easy visual inspection.
This variable is already built into the system and distinguishes
a GitHub Pages build from a local build.

When built on GitHub Pages, only one of GitHub or GitLab content
will be displayed at a time. There will also not be any distinctive
background color.
When building locally, both GitHub and GitLab content can be
displayed side-by-side and will use different background colors.
@unode unode force-pushed the gitlab-github-switch branch from b549235 to 01a8d38 Compare May 17, 2021 17:42
@unode
Copy link
Contributor Author

unode commented Jan 10, 2023

With the move to the new template system happening from May 2023 I'm not sure if this issue still makes sense.

I guess the crux is if we want to keep GitLab as an alternative in the same lesson or if instead we make it into a separate lesson. Any strong opinions about either?

@anenadic
Copy link
Contributor

I am not sure if toggable content will be possible in the new Workbench @unode from May 2023. If people have time, maybe they can look into and contributing this feature to the Workbench (unless it is already there).

@tobyhodges
Copy link
Member

There is an argument for keeping this lesson in the Jekyll template, so that it can continue to serve as a "living example" of he tooling and skills it aims to teach.

However, there are also myriad reasons to migrate to the Workbench.

Perhaps we should have a maintainers meeting some time soon? It's been a while and there are things to discuss.

@anenadic
Copy link
Contributor

There is an argument for keeping this lesson in the Jekyll template, so that it can continue to serve as a "living example" of he tooling and skills it aims to teach.

However, there are also myriad reasons to migrate to the Workbench.

Perhaps we should have a maintainers meeting some time soon? It's been a while and there are things to discuss.

We have our next maintainers meeting scheduled for Monday, February 6, 13:30 – 14:30 GMT (UTC+0). Would be good to meet if people are up for is - we have not had one in ages.

@unode
Copy link
Contributor Author

unode commented Jan 12, 2023

I'm at the moment available to meet on that time slot and would totally be up for it.

@unode
Copy link
Contributor Author

unode commented Feb 6, 2023

In light of GitHub actions and GitLab no longer being so centered on Jekyll we decided to abandon this direction.
If enough motivation is gathered we can always revisit.

@unode unode closed this Feb 6, 2023
@unode unode mentioned this pull request Feb 6, 2023
3 tasks
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.

3 participants