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

Launch Mouse microsite #302

Merged
merged 6 commits into from
Jan 28, 2022
Merged

Launch Mouse microsite #302

merged 6 commits into from
Jan 28, 2022

Conversation

danicheg
Copy link
Member

@danicheg danicheg commented Jan 27, 2022

Fixes #245.

This launches Mouse's microsite. I migrated our README and DEV to the site docs and added links to the Javadoc API (https://www.javadoc.io/doc/org.typelevel/mouse_2.13/latest/mouse/). At further work, we can add pages for every syntax. However, to publish microsite, we need to enable GitHub pages in the repo settings. Could you @benhutchison help with it?

To preview locally, run docs/mdoc and then docs/laikaPreview (site will be available at localhost:4242).

@github-pages github-pages bot temporarily deployed to github-pages January 27, 2022 21:10 Inactive
@benhutchison
Copy link
Member

micrositesettings

let me know if these settings are/not suitable

@danicheg
Copy link
Member Author

danicheg commented Jan 28, 2022

@benhutchison I'm not 100% on it, but it seems we should publish the site from the gh-pages branch (https://github.com/typelevel/mouse/pull/302/files#diff-b803fcb7f17ed9235f1e5cb1fcd2f5d3b2838429d4368ae4c57ce4436577f03fR232). This setting comes from sbt-typelevel, so I think we need to do that. I argue to merge this PR to main and then create branch gh-pages from main (yeah, it's working not as I expected.) and set it in the repo settings, of course.

EDIT: Hmm, probably I misunderstand something about the gh-pages branch, sorry. I need to dig into it well first.

EDIT-2: Well, probably I get it. We actually need to set gh-pages in the repo settings, but that branch will be managed by our CI job.

@danicheg
Copy link
Member Author

@benhutchison please, let me know if this PR is good for you and you've set the gh-pages branch in the repo settings.

@benhutchison
Copy link
Member

Good to merge. However, even on the current branch it seems to have published at https://typelevel.org/mouse/

I cant set the Pages branch to one that doesnt yet exist, its a dropdown selector

@danicheg
Copy link
Member Author

Oh, sorry, I'm at really first try on the publishing docs via github-pages. So, let's merge this first.

@danicheg danicheg merged commit a6d79d0 into main Jan 28, 2022
@danicheg
Copy link
Member Author

Branch gh-pages was created @benhutchison.

@benhutchison
Copy link
Member

Ive switched the Pages site to gh-pages

@benhutchison
Copy link
Member

Very nice outcome @danicheg 👏

@danicheg
Copy link
Member Author

Thanks, @benhutchison! We did it and I'm really excited about that.

@danicheg danicheg deleted the microsite branch January 28, 2022 08:51
@danicheg
Copy link
Member Author

Now we can do a release with a very good announcement.

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.

Microsite for mouse
2 participants