-
Notifications
You must be signed in to change notification settings - Fork 1.7k
feat(docs): New astro site - merge into main branch ✨ #938
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
Conversation
…rs#889) * chore(package.json): add angular commit helper deps and script * test(link checking): add lychee configuration re all-contributors#852 * test(link check): add script to check links in Markdown source * fix: correct link to eslint commit convention * fix: correct bot usage image path * test: add mdx to fallback extentions * fix: remove broken link * test: check links internal to a page * test: add root dir to link checking This ensures links to an absolute path (starting with '/') are directed to the public directory. fix 852 * ci: add markdownlint dep and script * style: fix linting errors * ci: install deps for lint workflow * ci: add offline link check for PRs and push to main This workflow will only check links to local files and not make network requests. There should therefore be no false negatives and it is safer to use as a required CI item.
docs: make index dynamic and add images docs: lint all docs and add markdown lint dep docs: lint Correct image path
docs:remove placeholder index page
…l-contributors#901) * docs(style): source gfonts poppins * docs(style): add custom style/ setup tailwind * docs(img): add and update images * docs(img): add and update images * docs(config): cleanup landing and config * chore(deps): update to support tailwind * chore(css): setup tailwind css * docs: add graphics for home page and style buttons * docs: add buttons * docs: missed a few more image updates * chore(deps): correct dependency location in package.lock * chore(clean): clean old files * chore: add poppins font license --------- Co-authored-by: Jim Madge <[email protected]>
…iew section (all-contributors#915) * docs: update images and document how to add content to our docs docs: update images and edit text for all intro pages docs: clean up all pages in the general overview section docs: add description for Ideas, projectManagement and promotion (all-contributors#829) docs: ✏️ Add dark mode README logo (all-contributors#741) Co-authored-by: Leah Wasser <[email protected]> Co-authored-by: Jim Madge <[email protected]> * enh(image): bring in dark mode compatible logo * docs: tidy adding images section Move path alias section up and adjust Apply suggestions from code review Co-authored-by: Jim Madge <[email protected]> * style: linting fixes for emoji table and other content --------- Co-authored-by: Jim Madge <[email protected]> Co-authored-by: Jim Madge <[email protected]>
…s#914) * docs: get docs online via github pages new branch * chore: set site and base according to astro docs Astro docs: https://docs.astro.build/en/guides/deploy/github/#how-to-deploy suggest how to specifiy the site url and base for GitHub pages. --------- Co-authored-by: Jim Madge <[email protected]>
* ci: correct workflow file format 🤦 * ci: add root directory to offline link check This ensures that the link checkers knows where to look for absolute links.
…ocumentation (all-contributors#919) * docs: update images and document how to add content to our docs docs: update images and edit text for all intro pages docs: clean up all pages in the general overview section docs: add description for Ideas, projectManagement and promotion (all-contributors#829) docs: ✏️ Add dark mode README logo (all-contributors#741) Co-authored-by: Leah Wasser <[email protected]> Co-authored-by: Jim Madge <[email protected]> * enh(image): bring in dark mode compatible logo * docs: tidy adding images section Move path alias section up and adjust Apply suggestions from code review Co-authored-by: Jim Madge <[email protected]> * style: linting fixes for emoji table and other content * docs: fix links and breakouts in bot section * Apply suggestions from code review Co-authored-by: Jim Madge <[email protected]> --------- Co-authored-by: Jim Madge <[email protected]> Co-authored-by: Jim Madge <[email protected]>
docs: add netlify badge for open source plan
…butors#933) docs(styles): apply stylesheets globally docs: document custom styles
…ributors#931) docs: fix links and images on last sections
…main (all-contributors#929) * chore(ci): add dependabot config for actions (all-contributors#865) * chore(ci): bump actions/checkout from 3 to 5 (all-contributors#883) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 5. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3...v5) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(ci): bump actions/setup-node from 3 to 4 (all-contributors#882) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3 to 4. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@v3...v4) --- updated-dependencies: - dependency-name: actions/setup-node dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(ci): bump actions/upload-pages-artifact from 3 to 4 (all-contributors#881) * chore(ci): bump actions/upload-pages-artifact from 3 to 4 Bumps [actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact) from 3 to 4. - [Release notes](https://github.com/actions/upload-pages-artifact/releases) - [Commits](actions/upload-pages-artifact@v3...v4) --- updated-dependencies: - dependency-name: actions/upload-pages-artifact dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> * Update .github/workflows/build-website.yml * chore(ci): update actions --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Leah Wasser <[email protected]> * chore(branch rename): rename master --> main throughout so ci runs and docs are correct (all-contributors#890) chore(rename master to main branch): we renamed the master branch; this updates all actions & docs * docs: ✏️ fix links to doc site and small bug in footer.js (all-contributors#871) * docs: ✏️ fix links to doc site and small bug in footer.js This change fixes an error in the footer and also updates some broken links. ✅ Closes: 870 * Update website/static/index.html Co-authored-by: Leah Wasser <[email protected]> * Update docs/overview.md --------- Co-authored-by: Jim Madge <[email protected]> * docs: add JimMadge as a contributor for review (all-contributors#892) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Leah Wasser <[email protected]> * docs: add JHWelch as a contributor for doc (all-contributors#894) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add lwasser as a contributor for review (all-contributors#897) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add JimMadge as a contributor for infra (all-contributors#896) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <[email protected]> * docs: ✏️ Add dark mode README logo (all-contributors#741) Co-authored-by: Leah Wasser <[email protected]> Co-authored-by: Jim Madge <[email protected]> * docs: add RichLewis007 as a contributor for bug, and doc (all-contributors#906) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add parthamk as a contributor for doc (all-contributors#909) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add rebeccaringuette as a contributor for ideas (all-contributors#910) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Change build branch from 'master' to 'docs-upgrade' * docs: add description for Ideas, projectManagement and promotion (all-contributors#829) * docs: add KhushiPandey8 as a contributor for doc (all-contributors#918) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add lwasser as a contributor for doc (all-contributors#921) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add JimMadge as a contributor for doc (all-contributors#922) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: linting fix * docs: remove last docusaurus files * docs: update * chore: fix linting step to handle mdx * chore: lint * fix: links --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <[email protected]> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <[email protected]> Co-authored-by: Jordan Welch <[email protected]> Co-authored-by: Reshama Shaikh <[email protected]>
@lwasser I think that works. Actually, it might be the best thing to do. The repositories style is to squash-rebase merge, so what you have done is probably closer to the actual pull request result. |
Yes! Thank you. I learned a hard lesson. In the future I will rebase as i work on every or in a feature branch !! It's just better and cleaner. |
Ok fantastic. @JimMadge, what do you think about merging this into main and then moving all of the workflows to main and archiving the feature branch? Yes this was a lesson learned in trying to do the "easier thing" which actually became harder. I am going to rebase as I go in the future!! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just one small change, to remove the placeholder text from the 404 page.
Co-authored-by: Jim Madge <[email protected]>
❌ Deploy Preview for all-contributors failed.
|
Ok great!! i merged the suggested change. and i'm going to merge this into main now!! we've reviewed all of the changes here at this point! Once we merge to main. All that is left is to update the actions to run on main rather than docs-upgrade. and the website is stable. We can customize the 404 further if we wish in a future PR!! |
ok somehow linting is broken again. 🤯 i'll fix - i swear i've fixed linting issues in 3 separate pr's. It will benice to go back to small manageable pr's after this! |
chore: docusaurus came back
6fa6477
to
940421c
Compare
Ok. failing checks are related to netlify!
|
Ok @JimMadge, something went wrong with the merge commit I added, and the docs-upgrade feature branch still has merge conflicts with main. My current suspicion is that my main branch locally was NOT synced with main here (my upstream). But i'm really not sure what happened. I just know that I made a bit of a mess.
So instead of merging i rebased the entire thing against main and this PR i the updated docs-upgrade feature branch that has the updated astro site.
What:
This is the feature branch rebased against main from my fork. I made sure docs-upgrade was synced with upstream here and then i rebased.
Why:
How:
Checklist:
Bot Usage
Let me know if there is a better way to implement this. i didn't want to fix the docs-upgrade branch directly here in the main repository.