[GitHub] [incubator-yunikorn-site] wilfred-s commented on pull request #8: [YUNIKORN-213] Init source code for yunikorn web-site v2

[GitBox <gi...@apache.org>]

wilfred-s commented on pull request #8:
URL: https://github.com/apache/incubator-yunikorn-site/pull/8#issuecomment-644604728


   
   > Right, from docusaurus document, it support create separated community, roadmap, etc. pages.
   > IMO, it's not a problem to keep them in `docs`.
   > 
   > https://v2.docusaurus.io/docs/creating-pages
   
   The location we store them is not really a problem. The problem is the fact that they are marked as versioned. We cannot mark these files as versioned. We need to do create static files for all the files that are not part of the normal doc revision cycle.
   The community, roadmap and download pages are not versioned and there should only ever be one version on the site available. When we create a new revision of the docs we need to exclude them too.
   
   > As I mentioned, document names are prefixed with letters for categorization. If add a new doc, need update `sidebars.js` also.
   
   This needs to be explained and documented somewhere. We should not require a contributor to figure this all out. What we at least need in the documentation is:
   - how to name a document
   - what tags to add inside the document
   - which config to update
   
   > > Last point what I do not see yet is the build and publish instructions
   > 
   > After run `yarn build`, the web site will be generated at `build` folder.
   
   The question then becomes: does it have all data needed and is that build directory clean enough to commit to the `asf-site` branch? How do we commit that: i.e. do we recursively copy just the `build` dir as the new content of the `asf-site` branch?
   We can create a staging setup in the repository which get deployed to an apache staging web server to check if it all works.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org