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

New documentation site with Docusaurus #466

Merged
merged 89 commits into from
Feb 20, 2024
Merged

New documentation site with Docusaurus #466

merged 89 commits into from
Feb 20, 2024

Conversation

danuw
Copy link
Collaborator

@danuw danuw commented Feb 13, 2024

Pull Request

Issue Number: #344

Summary

New documentation site using docusaurus currently available at https://green-software-foundation.github.io/carbon-aware-sdk/

Changes

Checklist

  • Local Tests Passing?
  • CICD and Pipeline Tests Passing?
  • Documentation Updates Made?
  • This is not a breaking change. If it is, please describe it below.

Is this a breaking change?

The documentation now sites elsewhere (in /casdk-docs/docs)

Anything else?

Other comments, collaborators, etc.

Please follow
GitHub's suggested syntax
to link Pull Requests to Issues via keywords

This PR Closes #344 #416 #382

danuw and others added 30 commits August 3, 2023 14:42
…rently copied into casdk-docs/docs to get live updates (copied and not moved so changes in main can be easily identified when rebasing once it all works)
vaughanknight and others added 3 commits February 13, 2024 00:00
DCO Remediation Commit for Vaughan Knight <vaughan@vaughanknight.com>

I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: da70ec4
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 6be74ff
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: fe5cef9
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: b4a7973
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: d0a954a
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 996d084
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 648a1ce
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 581267c
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 3c90f55
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 6c1514e
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 0592710
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: c59057c
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 0cec58f
I, Vaughan Knight <vaughan@vaughanknight.com>, hereby add my Signed-off-by to this commit: 028a179

Signed-off-by: Vaughan Knight <vaughan@vaughanknight.com>
@danuw danuw requested a review from vaughanknight as a code owner February 13, 2024 01:48
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 356ce09
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 2c342a8
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 04be596
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: c437b5b
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 46958d9
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 21a0e16
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 8bbe72e
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 62e2a95
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 5183d73
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 93267d6
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: ee8841c
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 2d7b4dd
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 68bbb2f
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 735a515
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: a31b391
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: b7483b6
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 4cece7b
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 83f3073
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 4799d7a
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: d2d823d
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: c3d832c
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: ec96b52
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 9567c45
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 4527514
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: ff729b0
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 1bdd2ad
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 012ca25
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: c7d4563
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: a51782f
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: cc15035
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 3c62bd4
I, Dan Benitah <bdanuw@gmail.com>, hereby add my Signed-off-by to this commit: 590f262

Signed-off-by: Dan Benitah <bdanuw@gmail.com>

DCO Remediation Commit for danuw <danuw@volto.io>

I, danuw <danuw@volto.io>, hereby add my Signed-off-by to this commit: fbc602c
I, danuw <danuw@volto.io>, hereby add my Signed-off-by to this commit: ac1432f
I, danuw <danuw@volto.io>, hereby add my Signed-off-by to this commit: 8166cf2
I, danuw <danuw@volto.io>, hereby add my Signed-off-by to this commit: 48f117e

Signed-off-by: danuw <danuw@volto.io>
I, danuw <danuw@volto.io>, hereby add my Signed-off-by to this commit: fbc602c
I, danuw <danuw@volto.io>, hereby add my Signed-off-by to this commit: ac1432f
I, danuw <danuw@volto.io>, hereby add my Signed-off-by to this commit: 8166cf2
I, danuw <danuw@volto.io>, hereby add my Signed-off-by to this commit: 48f117e

Signed-off-by: danuw <danuw@volto.io>
Signed-off-by: Dan Benitah <bdanuw@gmail.com>
@Sophietn
Copy link
Contributor

@danuw Docusaurus looks great! Thank you for all the work getting it to this point

@danuw danuw added the Ready for Review PR Ready for review with the GSF team for merge label Feb 13, 2024
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possibly can edit docusaurs scripts to add the required copy command for copying samples docs: cp -r ./samples/ ./casdk-docs/docs/ && <OTHER_COMMANDS>

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool will give it a go soon. Thanks

Signed-off-by: Osama Jandali <osamajandaly@gmail.com>
Signed-off-by: Osama Jandali <osamajandaly@gmail.com>
Signed-off-by: Osama Jandali <osamajandaly@gmail.com>
Signed-off-by: Osama Jandali <osamajandaly@gmail.com>
Signed-off-by: Osama Jandali <osamajandaly@gmail.com>
Signed-off-by: Osama Jandali <osamajandaly@gmail.com>
@danuw
Copy link
Collaborator Author

danuw commented Feb 20, 2024

Requested updates applied earlier (updated navigation text, links and blog images resized)

@vaughanknight @Willmish
cc @Sophietn

@vaughanknight
Copy link
Contributor

Doing a check now

@vaughanknight vaughanknight merged commit f3c6a73 into dev Feb 20, 2024
10 checks passed
Copy link
Contributor

@vaughanknight vaughanknight left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved!

@vaughanknight
Copy link
Contributor

Approved!

I hadn't clicked approve after reviewing in another tab :)

@Willmish Willmish deleted the docs/docusaurus branch February 20, 2024 21:56
@danuw danuw mentioned this pull request Feb 26, 2024
4 tasks
@danuw danuw removed the Ready for Review PR Ready for review with the GSF team for merge label Mar 5, 2024
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.

[Bug]: Some GHA were failed due to empty workflow [Bug]: Fix and update doc deployment workflow
10 participants