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

Mkdocs setup #1392

Merged
merged 4 commits into from May 17, 2022
Merged

Mkdocs setup #1392

merged 4 commits into from May 17, 2022

Conversation

meatballhat
Copy link
Member

@meatballhat meatballhat commented May 8, 2022

What type of PR is this?

  • cleanup
  • documentation

What this PR does / why we need it:

Adds initial mkdocs material configuration and index doc so that a docs site may be hosted via GitHub Pages.

Which issue(s) this PR fixes:

Fixes #1343
Fixes #1380

Special notes for your reviewer:

There was some mention in #1343 about possibly using docusaurus, but I threw this together given that other maintainers are either already familiar with mkdocs or prefer it to docusaurus.

@meatballhat meatballhat added kind/documentation describes a documentation update area/v2 relates to / is being considered for v2 kind/cleanup describes internal cleanup / maintaince labels May 8, 2022
@meatballhat meatballhat added this to the Release 2.x milestone May 8, 2022
@meatballhat meatballhat requested a review from a team as a code owner May 8, 2022
rliebz
rliebz previously approved these changes May 8, 2022
mkdocs-requirements.txt Outdated Show resolved Hide resolved
@meatballhat
Copy link
Member Author

meatballhat commented May 9, 2022

FYI out of band I've enabled GitHub Pages and added a CNAME record of:

cli.urfave.org. 3600 IN CNAME urfave.github.io.

@saintmalik
Copy link

saintmalik commented May 10, 2022

FYI out of band I've enabled GitHub Pages and added a CNAME record of:

cli.urfave.org. 3600 IN CNAME urfave.github.io.

Great, nice, sorry it took me some days to respond, can i help out also?

@saintmalik
Copy link

saintmalik commented May 10, 2022

Also noticed something: the pen editing button leads to a 404 page at the moment.

https://github.com/urvafe/cli/edit/main/docs/v2/index.md

@meatballhat
Copy link
Member Author

meatballhat commented May 14, 2022

@saintmalik What do you think of this PR? Reasonable enough as a first attempt?

@meatballhat meatballhat requested a review from a team May 14, 2022
@saintmalik
Copy link

saintmalik commented May 15, 2022

Yeah, its pretty awesome, and makes life easy for everyone

@kolyshkin
Copy link
Contributor

kolyshkin commented May 16, 2022

Hint: if you use git pull --rebase you can get rid of merge commits.

@meatballhat
Copy link
Member Author

meatballhat commented May 17, 2022

Hint: if you use git pull --rebase you can get rid of merge commits.

@kolyshkin yep I'm aware 😁 I realize the whole merge/rebase debate has a long history that I definitely don't want to engage in here. Suffice to say I'm in favor of adapting my preferences to what works for fellow contributors. Any chance you're up for opening a discussion if you'd like to see a rebase-centric set of workflows and norms?

@meatballhat meatballhat merged commit 97a222b into main May 17, 2022
13 checks passed
@meatballhat meatballhat deleted the mkdocs-setup branch May 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/v2 relates to / is being considered for v2 kind/cleanup describes internal cleanup / maintaince kind/documentation describes a documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants