{"id":17536362,"url":"https://github.com/apache/geode-site","last_synced_at":"2025-04-17T15:33:00.347Z","repository":{"id":37561972,"uuid":"82777101","full_name":"apache/geode-site","owner":"apache","description":"Apache Geode website content","archived":false,"fork":false,"pushed_at":"2025-01-22T17:46:39.000Z","size":73210,"stargazers_count":4,"open_issues_count":1,"forks_count":14,"subscribers_count":51,"default_branch":"master","last_synced_at":"2025-04-10T11:58:51.548Z","etag":null,"topics":["geode"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-22T08:00:06.000Z","updated_at":"2024-10-18T02:06:03.000Z","dependencies_parsed_at":"2025-01-22T18:37:41.121Z","dependency_job_id":null,"html_url":"https://github.com/apache/geode-site","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fgeode-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fgeode-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fgeode-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fgeode-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/geode-site/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248662264,"owners_count":21141543,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["geode"],"created_at":"2024-10-20T20:00:38.951Z","updated_at":"2025-04-17T15:33:00.316Z","avatar_url":"https://github.com/apache.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\nLicensed to the Apache Software Foundation (ASF) under one or more\ncontributor license agreements.  See the NOTICE file distributed with\nthis work for additional information regarding copyright ownership.\nThe ASF licenses this file to You under the Apache License, Version 2.0\n(the \"License\"); you may not use this file except in compliance with\nthe License.  You may obtain a copy of the License at\n\n     http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n--\u003e\n\n[\u003cimg src=\"https://geode.apache.org/img/Apache_Geode_logo.png\" align=\"center\"/\u003e](http://geode.apache.org)\n\n[![Build Status](https://travis-ci.org/apache/geode-site.svg?branch=master)](https://travis-ci.org/apache/geode-site) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0) \n\n\n# Apache Geode Site\n\nThis repository contains the source files for the [Apache Geode website](https://geode.apache.org). \n\nThe repository contains two branches:\n\n- The __master__ branch contains the site's HTML framework, composed of the top-level landing page and the next level of pages, such as Docs, Community, and Releases, and the tools needed to compile the deployable site. \n\n  Content resides under the `website/content` directory. These sources are compiled into a deployable site by gradle scripts using a tool called [Pandoc](http://johnmacfarlane.net/pandoc).\n\n- The __asf-site__ branch contains a copy of the deployable site built from the __master__ branch, fleshed-out with __externally-generated__ content, which includes all non-framework content such as the User Guide and the Javadocs, which you build separately then add manually on the __asf-site__ branch before publishing the completed site. Stylesheets also reside on the __asf-site__ branch.\n\n  To deploy the Apache Geode website, you push the __asf-site__ branch to the upstream Apache repository. An Apache \"sync\" tool monitors the __asf-site__ branch \nof the repository and publishes your update to the\n[Geode website](http://geode.apache.org) after a 5-10 minute delay.\n\n\n# Update procedure\nUpdating the website is a two-part process:\n\n1. On the __master__ branch, update the website's framework pages.\n\n1. Check out the __asf-site__ branch and add externally-generated content, such as the User Guide and the Javadocs.\n\nWhen the site's updated framework has been fleshed-out with external content, the site is ready to be deployed.\n\n## Prerequisites\n\nTo generate the site locally, you need to install java and docker. \n\nOther support tools you may need include:\n\n- pandoc\n- nanoc\n\n## Update the website framework\n\nOn the __master__ branch, update the website's framework pages. For a general release, this would likely include:\n\n  - {geode-site}/website/content/index.html\n  - {geode-site}/website/content/community/index.html\n  - {geode-site}/website/content/docs/index.html\n  - {geode-site}/website/content/releases/index.html\n\nA couple of notes specific to documentation:\n\n  - The Geode website is not equipped to understand the `redirects.rb` substitutions provided with the Geode and Geode Native user guides. On this site, the file `website/content/.htaccess` provides redirect information. Edit this file on the __master__ branch, and the `gradlew publish` operation will propagate your changes to the __asf-site__ branch.\n  - If you need to change the layout or styling of the site, then you will probably need to change\nan HTML, JS or CSS file on the __asf-site__ branch.\n\n\n## Locally generate the site framework and review your changes\n\nYou should still be on the __master__ branch. \n\n1. Generate the site content by navigating to the top level directory of the `geode-site` repo and using gradle to compile the sources into a deployable site framework:\n\n    ```\n    $ ./gradlew compile\n    ```\n\n  You may need to suppress rat checking: add `-x rat` to the end of the `.gradlew` command.\n\n2. View the generated site by running:\n\n    ```\n    $ ./gradlew view\n    ```\n    \n  and point your browser at `http://localhost:3000` to view the result. \n\n  You may need to suppress rat checking: add `-x rat` to the end of the `.gradlew` command.\n\n3. To make further changes, stop the build (Ctrl-C), edit files, recompile, and view again.\n\n4. Once you are happy with your changes, commit them to the __master__ branch and push them to the upstream Apache repository.\n\n## Add externally-generated content to the site framework\n\n### 1. On the __master__ branch, run the gradle command:\n\n    $ ./gradlew publish\n\n  The gradle `publish` target:\n\n  - Checks out the __asf-site__ branch, and\n  - Copies the website files to their deployment directories.\n\n**HEADS-UP**\nThe `gradlew publish` command *does not* update the `css` and `stylesheets` directories. If you made format changes there, you must manually merge the new versions of those files from the __master__ branch.\n\n  - While still on the __master__ branch, save those files to a location outside the geode-site repo.\n  - After running the `gradlew publish` command, copy the new versions to the appropriate directories in the __asf-site__ branch.\n\n\n### 2. Add a new user guide\n\n1. Create a local build of the User Guide as described in `{geode-project-dir}/geode-book/README.md`. \n\n1. Copy the User Guide to the `geode-site` repo:\n\n  1. On the __asf-site__ branch, create a destination directory for the User Guide. The naming convention is:\n\n        ```\n        {geode-site}/docs/guide/XY\n        ```\n  where `XY` is the product version of your documentation (e.g., `{geode-site}/website/content/docs/guide/17` if you are publishing the documentation for Apache Geode 1.14). So, if your current working directory is the top level of `{geode-site}`, you would create the destination directory with the following command:\n\n        ```\n        $ mkdir -p {geode-site}/docs/guide/114\n        ```\n\n  1. Navigate to the User Guide you have built in the Geode repository: `{geode-project-dir}/geode-book/final_app/public/docs/guide/XY`.\n\n  1. Use `tar` to copy the directory in order to preserve links and other filesystem niceties.\n\n  - Create the tarfile in your Desktop for easy access on the retrieval side.\n\n        ```\n        $ tar cvf ~/Desktop/new-guide-content.tar .\n        ```\n\n  - Navigate to the target directory and un-tar the userguide archive:\n\n        ```\n        $ cd {geode-site}/docs/guide/XY\n        $ tar xvf ~/Desktop/new-guide-content.tar\n        ```\n\n  - Replace the entire `docs/guide/latest` directory with a copy of the latest user guide's directory. Use `tar` (rather than `cp`) to preserve the original directory's structure.\n\n        ```\n        $ cd {geode-site}/docs/guide\n        $ rm -rf latest\n        $ mkdir latest\n        $ cd latest\n        $ (cd ../XY \u0026\u0026 tar cf - *) | (tar xf -)\n        ```\n  \n### 3. Publish new javadocs\n\nYou should still be on the __asf-site__ branch. Copy new javadocs directly to the directory\n`{geode-site}/releases/latest/javadoc/`.\n\nThe new javadocs _replace_ those currently within the directory.\n\n## Deploy the update\nCommit and push the __asf-site__ branch. Apache detects the update and publishes it. The site should update in 5-10 minutes.\n\n## Troubleshooting\n\n- If the site does not update in 5-10 minutes, __push a new commit by adding or subtracting a blank line in the top-level `index.html` file.__ This usually does the trick.\n\n- Check your commit of the __asf-site__ branch. The site's deployable files are at the top level, rooted at {geode-site}/index.html. Make sure that directories such as `{geode-site}/docs` and `{geode-site}/releases` contain the latest versions of `index.html` and the docs.\n\n- DO NOT commit the {geode-site}/build directory. This is the place where files compiled on the __master__ branch are placed, then retrieved after the switch to the __asf-site__ branch. It must be freshly generated with each iteration, not saved to the repo.\n\nFor further assistance, you can\n\n- [file a JIRA against the INFRA project](https://issues.apache.org/jira/browse/INFRA), or \n\n- ask for advice on the Infrastructure project's HipChat room [#asfinfra](https://www.hipchat.com/g4P84gemn).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fgeode-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fgeode-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fgeode-site/lists"}