Comments (10)
Per my discussion with @maoo on 2020.1.31 it's my understanding that this is the issue that would address the need to make it much easier for developers to run builds of documentation sites on their forks, such that they can share their WIP (work in progress) with other collaborators in the form of their fork build of the doc site.
This has come up with Alloy as there are several people who will be working on the documentation site concurrently and it would be useful to share ideas with each other by showing our build on our fork before doing PRs into the base repo.
It sounds like at least part of the work would be to parameterize some of the fields in website/siteConfig.js
(e.g., cname, url
, baseUrl
and .travis.yml
, and to also handle different scenarios for if/how a CNAME record is used.
from open-developer-platform.
@brooklynrob - I've set up a meeting with @mcleo-d @maoo on Monday to discuss this and a couple of other issues on Microsite / GH UX - and how best to address for users with less technical experience. Plus, we'll discuss some other items that should go into the Documents and branding of microsites (current and future via the microsite blueprint). Thanks
from open-developer-platform.
@grizzwolf @mcleo-d @maoo A good example I thought of when discussing this w/ @toshaellison today was the way in which Riko's fork, https://rikoe.github.io/FDC3/docs/use-cases/overview (no longer up) became our de facto staging/testing/integrate environment during the FDC3 doc site says. Grizz's did too.
from open-developer-platform.
@grizzwolf @mcleo-d @maoo Versioning might be another way to fulfill this. See https://docusaurus.io/docs/en/tutorial-version. This sentence, especially the last part, is what caught my eye: "Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion." -- I am looking for a way to stage/test/show documentation to a small group of reviewers for comment first before releasing it to everyone.
from open-developer-platform.
Another idea for how to implement this (a staging/integration environment in which to stage/evaluate proposed documentation changes) for, say, Alloy.
- (Current) Production: Doc commits made to
master
branch configured to build and deploy pages into thegh-pages
branch, which deploys toalloy.finos.org
- (Suggested) Test/Stages: Commits made/merged to a (say)
docs-test
branch configured to build and deploy pages into thegh-pages-test
branch, which deploys toalloy-test.finos.org
. Changes promoted from test to production as ready to go/approved. - (Optional) Dev: Commits made/merged to a
docs-dev
branch configured to build and deploy pages into thegh-pages-dev
branch, which deploys toalloy-dev.finos.org
I.e., use the same build infrastructure and process, and make use of branches and two new hostnames to create 1 or 2 more instances (test and dev). Additionally, probably make process that pull requests are merged into the lowest (i.e., test if there is no dev; otherwise dev) level and then commits promoted as part of the editorial review process.
from open-developer-platform.
Working on a promising spike on https://github.com/maoo/finos-fo/blob/master/PUBLISH_SITE.md
Still need to test the PR comment feature, but the build works like a charm and doesn't need any configuration (as opposed to the Travis CI approach we followed so far).
When all is tested and working, we will adopt this build on https://github.com/finos/open-developer-platform and test the full PR workflow.
from open-developer-platform.
I believe we're talking about two different features of microsite development on this thread, so have created...
- Create a build feature that allows FINOS microsite developers to demonstrate their in-development Docusaurus sites from their forks #60
... to follow the in-development microsite feature raised by @brooklynrob.
The solution being delivered in this issue #19 is a PR feature that allows project maintainers to review the contents of a microsite PR before accepting the build, which is post development.
from open-developer-platform.
@maoo - Thanks for all the work done ask part of this story 😺
Please move this item to In Progress on the ODP kanban if the story has been picked and in play.
https://github.com/orgs/finos/projects/8#card-31823971
Please note, I have raised #60 to capture the requirements of @brooklynrob which could be different to the scope of this story.
Thanks buddy 👍
from open-developer-platform.
Code is done and running, see https://github.com/finos/open-developer-platform/blob/master/docs/docusaurus-build-action.md
The comment feature is currently failing with a 403 ; I found a similar issue on danger/danger-js#918 , would be worth asking GitHub how we can make it work.
Happy to demo this action during the next ODP meeting!
from open-developer-platform.
Just created #74 and #75 with the issues left, so we can close this one.
Docs available on https://finosfoundation.atlassian.net/wiki/spaces/FDX/pages/1411317820/Docusaurus+Build+Action
from open-developer-platform.
Related Issues (20)
- Rename [email protected] to [email protected]
- Provide update on improved WhiteSource features HOT 4
- 7 Oct 2020 - ODP Meeting Minutes HOT 13
- Contributor (Developer) Profile HOT 2
- Push/Pull Targeted Help Wanteds based on Contributor interests/competencies HOT 1
- Add attendee organizations/affiliations to GitHub hosted FINOS project agendas and minutes HOT 5
- Make it possible to run forked version of a docs site w/o having to edit siteConfig.js HOT 7
- Add documentation to odp.finos.org on how to run a forked version of a docs site HOT 3
- More docs on project collaboration HOT 1
- 21 October 2020 - ODP Meeting Minutes HOT 7
- 4 November 2020 - ODP Meeting Minutes HOT 4
- 18 November 2020 - ODP Meeting Minutes HOT 1
- ODP Meeting minutes action fails (when unknown attendees are found) HOT 1
- Build website for the Open Source Readiness project HOT 1
- 16 december 2020 - ODP Meeting Minutes HOT 3
- Enable GitHub meeting attendance tracking for DevOps Mutualization HOT 3
- 28 Jan 2021 - Git Proxy Meeting Minutes HOT 12
- Use main branch in project blueprint HOT 1
- Help developing a new metric HOT 2
- Cannot install WhiteSource for GitHub.com integration HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from open-developer-platform.