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

Port user guide pages from wiki #1597

Merged
merged 1 commit into from
Mar 17, 2021
Merged

Conversation

starkos
Copy link
Member

@starkos starkos commented Mar 16, 2021

What does this PR do?

Port all of the user guide content from the wiki to the new website.

How does this PR change Premake's behavior?

Website only, no code changes.

Anything else we should know?

There is still more to do before taking the site live; see #1547.

Did you check all the boxes?

  • Focus on a single fix or feature; remove any unrelated formatting or code changes
  • Add unit tests showing fix or feature works; all tests pass
  • Mention any related issues (put closes #XXXX in comment to auto-close issue when PR is merged)
  • Follow our coding conventions
  • Minimize the number of commits

You can now support Premake on our OpenCollective. Your contributions help us spend more time responding to requests like these!

@starkos starkos mentioned this pull request Mar 16, 2021
7 tasks
@KyrietS
Copy link
Member

KyrietS commented Mar 16, 2021

EDIT: In my previous comment I said that using [text](name-of-file) instead of [text](Name-Of-File.md) won't give us warnings about broken links. But it's not true: https://v2.docusaurus.io/docs/docusaurus.config.js/#onbrokenlinks. Sorry for that.

All looks great. Just one little thing. We still have many warnings about broken links.

A few examples:

  • in Home.md there is broken link to What's-New-in-5.0.md.
  • in Command-Line-Arguments.md there is Adding-a-new-Action instead of Adding-New-Action.
  • many broken links in Lua-Library-Additions. Most of them are to the files I deleted as they were auto-generated without sensible content.

run npm run build to see all warnings.

For CI job I'd like to change onBrokenLinks: 'warn' to onBrokenLinks: 'throw' so every version of our website is going to have no broken links.

@starkos
Copy link
Member Author

starkos commented Mar 17, 2021

I guess I misunderstood how/when broken links were reported. I've now run npm run build and fix all issues, and I also added a note to README.md for future developers. If I don't hear otherwise I'll go ahead and merge this later today.

For CI job I'd like to change onBrokenLinks: 'warn' to onBrokenLinks: 'throw'

Yes, definitely.

@starkos starkos self-assigned this Mar 17, 2021
@KyrietS
Copy link
Member

KyrietS commented Mar 17, 2021

Warnings about broken markdown links (e.g. [text](Some-File.md)) are reported in dev mode when you run npm start. But raw links, like [text](some/relative/path) are checked during build process only.

Now it looks good to me 👍

@starkos
Copy link
Member Author

starkos commented Mar 17, 2021

Thanks for the review. Merging now, and then I'll get started on the index and download landing pages.

@starkos starkos merged commit 2fb34d0 into premake:master Mar 17, 2021
@starkos starkos deleted the website-user-guide branch March 17, 2021 17:45
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.

2 participants