- About The Project
- Getting Started Building a Local Deployment of the GemFire Developer Center
- Troubleshooting
- Contributing Content
- Code of Conduct
The VMware GemFire Developer Center is a site specifically built to be a great resource for GemFire users.
Before you can build a local copy of the GemFire Developer Center, there are software prerequisites that you’re going to need to install.
Note: The instructions below are primarily designed for Mac users. While you should be able to make things work on Windows as well, it may require a few additional steps. For example, using make should work natively on a Mac with Xcode dev tools installed, but requires a special installation for Windows.
- Hugo
- npm
- Docker
- [make] (https://www.gnu.org/software/make/)
-
Install Hugo — The GemFire Developer Center uses Hugo to build the site from Markdown files. You'll need to get Hugo if you want to build and run the site locally. Make sure you install the extended version with support for SCSS/SASS. This site currently uses 0.133.0 to build so if you're using a different version, your experience may vary. To install
hugo, follow the instructions for your specific environment as detailed in the hugo documentation. Ultimately, you have two main options:- Use
brew install hugo(MacOS only.) - Download the correct binary for your OS from gohugo GitHub releases and then move the
hugobinary to an appropriate location (ie.sudo cp hugo /usr/local/bin) and/or add it to yourPATH.
- Use
-
Install Node (and NPM) — Certain features of the site require Node in order to build (PostCSS, Autoprefixer, etc.), and the Node Package Manager (npm) is also used to manage local packages. If you don’t already have Node installed, you’ll need it in order to build the site. Though it may work with different versions, you should use Node 18+ and npm 10+ (the corresponding version that comes with Node 18). You may download and install Node or use
brewto install it:brew install node@18 brew link node@10
-
Install Docker — Docker builds images for local automated tests. You can download Docker Desktop or use
brew:brew install docker --cask
Note: Mac OS X requires Docker Desktop 2.4 or later
To get a local copy of the GemFire Developer Center up and running, follow these steps:
-
Clone the repository.
git clone --recurse-submodules https://github.com/gemfire/gemfire-developer-website
-
(option 1) Build a preview of the website with the Makefile. The website will be available at
http://localhost:1313/developer.make preview
-
(option 2) Build a preview of the website using Hugo's build command. The website will be available at
http://localhost:1313/developer.
hugo -b http://localhost:1313/With the change with how the theme files are overridden, the first time you update your branch you may see the following issue when running make preview:
git submodule update --init --recursive
Submodule 'themes/docsy' (https://github.com/google/docsy.git) registered for path 'themes/docsy'
fatal: not a git repository: /private/tmp/gemfire-developer-website/themes/docsy/../../.git/modules/themes/docsy
Failed to clone 'themes/docsy'. Retry scheduled
BUG: submodule considered for cloning, doesn't need cloning any more?
fatal: could not get a repository handle for submodule 'themes/docsy'
make: *** [theme] Error 1
You can run the following command for a one-time fix:
rm -rf .git/modules && rm -rf themes/docsy && mkdir themes/docsy
This is due to the number of files that are opened during the process of building the site. If you're on OSX, this can be addressed with the following command:
sudo launchctl limit maxfiles 65535 200000
ulimit -n 65535
sudo sysctl -w kern.maxfiles=100000
sudo sysctl -w kern.maxfilesperproc=65535
On Windows, you may need to use hugo server -D to start the application. The site will then be available on http://localhost:1313/
We, the Admin team of the GemFire Developer Center adhere to a code of conduct that you can read more about here: CODE_OF_CONDUCT.md