Move gh-pages into main branch #3868
Conversation
…OpenAPI-Specification.git:gh-pages
gh-pages; Draft registry content
Add v3.0.2 respec/html
gh-pages; update index.md
[gh-pages] Hand-craft API templates for leaner output
Signed-off-by: Mike Ralphson <[email protected]>
Make 3.1 schemas retrievable from their $ids
Signed-off-by: Mike Ralphson <[email protected]>
Add v3.1 2021-05-20 schemas to website
Signed-off-by: Mike Ralphson <[email protected]>
Signed-off-by: GitHub <[email protected]> Co-authored-by: webron <[email protected]>
* Added formats to the registry as defined by OpenAPI v3 * Fixed date-time format * Removed boolean as format is not needed
docs/.gitignore
Outdated
| node_modules/ | ||
| scripts/ | ||
| package-lock.json |
There was a problem hiding this comment.
Should these be here? As far as I can tell only _site/ and deploy/ are moving under docs/, but not the scripts and node environment?
There was a problem hiding this comment.
These were pre-existed but since there isn't any need for them I have removed them here 83770b9
|
Aside from the one comment, this looks good to me. I'm just going to hold off actually approving it until we know who has the permissions to do the actual deployment changes and can be sure that they'll merge and make those changes at the same time. [EDIT: Plus we're still considering just making a separate repo] |
|
I don't have the permissions needed. I see the source, but not the branch picker. How can we test this before we do it? Did you try it out on o a public fork, or who can do that? I expected the |
@lornajane My bad. My fork is the https://github.com/Bellangelo/OpenAPI-Specification which deploys to the https://bellangelo.github.io/OpenAPI-Specification/. I have made some extra changes to the deploy / build scripts based on some finding from @ralfhandl . If you check this action https://github.com/Bellangelo/OpenAPI-Specification/actions/runs/9375129267 you can see that it passes. The way I have been testing the changes in the site so far is mainly using the fork. The fork copies also some repo settings about the deployment but you have to fork through the Github's UI. If you do this, you will be able to deploy the same way we deploy here but in our own url. |
|
I've created issue OAI/Arazzo-Specification#207 on the Arazzo repo to change our respec job so that it will work with the new structure. |
|
Also note that #3900 will need to be incorporated into this PR if it's merged prior to this PR. |
|
@Bellangelo just wanted to drop you a note to say we haven't forgotten about your excellent work, just a lot of moving parts. We will figure it out. |
|
Sorry, closed the wrong PR! |
Closes #3717
What I have done:
gh-pagesand move all files under thedocsfolder which Github supports.mainbranch and rungit merge gh-pages --allow-unrelated-histories. This merged the 2 branches even if they had unrelated histories.What we need to do after merge:
Settings>Pagesand under theBranchsection select themainbranch and thedocsfolder`.gh-pagesfor a few weeks, just to be able to quickly change in case of a bug in the process, and then we delete it.How to review
To quickly skip and verify the updated files, just follow the
What I have donesection and then you can justgit diffto distinguished what files have been moved and what files contain actual changes.