diff --git a/.gitignore b/.gitignore index 7483d1710..065477ab1 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ /dune-project *~ cache/* +Version.ml diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 24a63b809..f6e6b62ed 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -8,6 +8,20 @@ stages: - build_and_deploy_website - test +.website_build: &website_build + stage: build_and_deploy_website + image: node:8 + before_script: + - cd gitlab-pages/website + - npm install + script: + - npm run version next + - npm run build + after_script: + - cp -r gitlab-pages/website/build/ligo public + artifacts: + paths: + - public .docker: &docker image: docker:1.11 @@ -16,7 +30,7 @@ stages: .docker_build: &docker_build script: - - docker build -t $LIGO_REGISTRY_IMAGE:latest -f ./docker/Dockerfile . + - docker build -t $LIGO_REGISTRY_IMAGE:next -f ./docker/Dockerfile . .before_script: &before_script before_script: @@ -90,8 +104,9 @@ build-current-docker-image: <<: *docker_build except: - master + - dev -# When a MR/PR is merged to master +# When a MR/PR is merged to dev # take the previous build and publish it to Docker Hub build-and-publish-latest-docker-image: stage: build_and_deploy_docker @@ -99,25 +114,16 @@ build-and-publish-latest-docker-image: <<: *docker_build after_script: - docker login -u $LIGO_REGISTRY_USER -p $LIGO_REGISTRY_PASSWORD - - docker push $LIGO_REGISTRY_IMAGE:latest + - docker push $LIGO_REGISTRY_IMAGE:next only: - - master + - dev +# Pages are deployed from both master & dev, be careful not to override 'next' +# in case something gets merged into 'dev' while releasing. pages: - stage: build_and_deploy_website - image: node:8 - before_script: - - cd gitlab-pages/website - - npm install - script: - - npm run build - - pwd - - cd ../.. - - pwd - - cp -r gitlab-pages/website/build/ligo public - artifacts: - paths: - - public + <<: *website_build only: - master + - dev + diff --git a/gitlab-pages/.gitignore b/gitlab-pages/.gitignore index 5395ea795..3f87a979e 100644 --- a/gitlab-pages/.gitignore +++ b/gitlab-pages/.gitignore @@ -10,3 +10,5 @@ website/build/ website/yarn.lock website/node_modules website/i18n/* +website/versioned_docs/version-next +website/versioned_sidebars/version-next-sidebars.json \ No newline at end of file diff --git a/gitlab-pages/Makefile b/gitlab-pages/Makefile deleted file mode 100644 index fab8d821f..000000000 --- a/gitlab-pages/Makefile +++ /dev/null @@ -1,2 +0,0 @@ -up: - docker-compose up diff --git a/gitlab-pages/docker-compose.yml b/gitlab-pages/docker-compose.yml index 6711192ae..79619bae3 100644 --- a/gitlab-pages/docker-compose.yml +++ b/gitlab-pages/docker-compose.yml @@ -13,6 +13,9 @@ services: - ./website/i18n:/app/website/i18n - ./website/pages:/app/website/pages - ./website/static:/app/website/static + - ./website/versioned_sidebars:/app/website/versioned_sidebars + - ./website/versioned_docs:/app/website/versioned_docs - ./website/sidebars.json:/app/website/sidebars.json - ./website/siteConfig.js:/app/website/siteConfig.js + - ./website/versions.json:/app/website/versions.json working_dir: /app/website diff --git a/gitlab-pages/docs/contributors/documentation-and-releases.md b/gitlab-pages/docs/contributors/documentation-and-releases.md new file mode 100644 index 000000000..977c9a9c7 --- /dev/null +++ b/gitlab-pages/docs/contributors/documentation-and-releases.md @@ -0,0 +1,20 @@ +--- +id: documentation-and-releases +title: Documentation and releases +--- + + +## Documentation + +In case you'd like to contribute to the docs, you can find them at [`gitlab-pages/docs`]() in their raw markdown form. +Deployment of the docs/website for LIGO is taken care of within the CI, from `dev` and `master` branches. + +## Releases & versioning + +### Development releases (next) + +Development releases of Ligo are tagged as `next` and are built with each commit to the `dev` branch. Both the docker image & the website are published automatically. + +### Stable releases + +Releases tagged with version numbers `x.x.x` are built manually, both docs & the docker image. While deployment of the website is handled by the CI. diff --git a/gitlab-pages/docs/contributors/contributing/getting-started.md b/gitlab-pages/docs/contributors/getting-started.md similarity index 100% rename from gitlab-pages/docs/contributors/contributing/getting-started.md rename to gitlab-pages/docs/contributors/getting-started.md diff --git a/gitlab-pages/docs/setup-installation.md b/gitlab-pages/docs/setup-installation.md index a08db5e30..c3e5111c6 100644 --- a/gitlab-pages/docs/setup-installation.md +++ b/gitlab-pages/docs/setup-installation.md @@ -5,22 +5,24 @@ title: Installation There are currently two ways to get started with Ligo, both of those will allow you to use the Ligo CLI with your contracts. You can choose to use either the Docker image, or to compile & build the Ligo CLI yourself. -## Docker +## Dockerized installation (recommended) > 🐳 You can find instructions on how to install Docker [here](https://docs.docker.com/install/). -Easiest way to use LIGO is through the Docker image available at [Docker Hub](https://hub.docker.com/r/stovelabs/granary-ligo). Sources for the image can be found on [Github](https://github.com/stove-labs/granary/blob/develop/docker/ligo/Dockerfile). +Easiest way to use LIGO is through the Docker image available at [Docker Hub](https://hub.docker.com/r/ligolang/ligo). Sources for the image can be found on [Gitlab](https://gitlab.com/ligolang/ligo/blob/master/docker/Dockerfile). You can either run the docker image yourself, or you can setup a global ligo executable as shown below. ### Setting up a globally available `ligo` executable -```zsh -wget https://gitlab.com/maht0rz/ligo-documentation/blob/master/ligo-docker.sh && \ -sudo cp ligo-docker.sh /usr/local/bin/ligo && \ -sudo chmod +x /usr/local/bin/ligo && \ -rm ligo-docker.sh -``` -> ⚠️ Please note that the **current docker image is quite chunky**, it may take a while to download depending on your internet connection. +> You can install additional ligo versions by replacing `next` with the required version number + +```zsh +# next (pre-release) +curl https://gitlab.com/ligolang/ligo/raw/dev/scripts/installer.sh | bash -s "next" + +# e.g. 1.0.0 (stable) +curl https://gitlab.com/ligolang/ligo/raw/master/scripts/installer.sh | bash -s "1.0.0" +``` **Verify your ligo installation by running:** ```zsh @@ -28,9 +30,9 @@ ligo --help ``` -## Manual installation +## Manual installation (advanced) -For now, please refer to the steps described in the [Dockerfile](https://github.com/stove-labs/granary/blob/develop/docker/ligo/Dockerfile). +For now, please refer to the steps described in the [Dockerfile](https://gitlab.com/ligolang/ligo/blob/master/docker/Dockerfile). diff --git a/gitlab-pages/docs/tutorials/firsts-smart-contract.md b/gitlab-pages/docs/tutorials/firsts-smart-contract.md new file mode 100644 index 000000000..b210a4d15 --- /dev/null +++ b/gitlab-pages/docs/tutorials/firsts-smart-contract.md @@ -0,0 +1,6 @@ +--- +id: first-smart-contract +title: My first LIGO smart contract +--- + +TODO \ No newline at end of file diff --git a/gitlab-pages/website/blog/2016-03-11-blog-post.md b/gitlab-pages/website/blog/2016-03-11-blog-post.md deleted file mode 100644 index cf2ba2960..000000000 --- a/gitlab-pages/website/blog/2016-03-11-blog-post.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Blog Title -author: Blog Author -authorURL: http://twitter.com/ -authorFBID: 100002976521003 ---- - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus elementum massa eget nulla aliquet sagittis. Proin odio tortor, vulputate ut odio in, ultrices ultricies augue. Cras ornare ultrices lorem malesuada iaculis. Etiam sit amet libero tempor, pulvinar mauris sed, sollicitudin sapien. - - - -Mauris vestibulum ullamcorper nibh, ut semper purus pulvinar ut. Donec volutpat orci sit amet mauris malesuada, non pulvinar augue aliquam. Vestibulum ultricies at urna ut suscipit. Morbi iaculis, erat at imperdiet semper, ipsum nulla sodales erat, eget tincidunt justo dui quis justo. Pellentesque dictum bibendum diam at aliquet. Sed pulvinar, dolor quis finibus ornare, eros odio facilisis erat, eu rhoncus nunc dui sed ex. Nunc gravida dui massa, sed ornare arcu tincidunt sit amet. Maecenas efficitur sapien neque, a laoreet libero feugiat ut. - -Nulla facilisi. Maecenas sodales nec purus eget posuere. Sed sapien quam, pretium a risus in, porttitor dapibus erat. Sed sit amet fringilla ipsum, eget iaculis augue. Integer sollicitudin tortor quis ultricies aliquam. Suspendisse fringilla nunc in tellus cursus, at placerat tellus scelerisque. Sed tempus elit a sollicitudin rhoncus. Nulla facilisi. Morbi nec dolor dolor. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Cras et aliquet lectus. Pellentesque sit amet eros nisi. Quisque ac sapien in sapien congue accumsan. Nullam in posuere ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Proin lacinia leo a nibh fringilla pharetra. - -Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Proin venenatis lectus dui, vel ultrices ante bibendum hendrerit. Aenean egestas feugiat dui id hendrerit. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Curabitur in tellus laoreet, eleifend nunc id, viverra leo. Proin vulputate non dolor vel vulputate. Curabitur pretium lobortis felis, sit amet finibus lorem suscipit ut. Sed non mollis risus. Duis sagittis, mi in euismod tincidunt, nunc mauris vestibulum urna, at euismod est elit quis erat. Phasellus accumsan vitae neque eu placerat. In elementum arcu nec tellus imperdiet, eget maximus nulla sodales. Curabitur eu sapien eget nisl sodales fermentum. - -Phasellus pulvinar ex id commodo imperdiet. Praesent odio nibh, sollicitudin sit amet faucibus id, placerat at metus. Donec vitae eros vitae tortor hendrerit finibus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Quisque vitae purus dolor. Duis suscipit ac nulla et finibus. Phasellus ac sem sed dui dictum gravida. Phasellus eleifend vestibulum facilisis. Integer pharetra nec enim vitae mattis. Duis auctor, lectus quis condimentum bibendum, nunc dolor aliquam massa, id bibendum orci velit quis magna. Ut volutpat nulla nunc, sed interdum magna condimentum non. Sed urna metus, scelerisque vitae consectetur a, feugiat quis magna. Donec dignissim ornare nisl, eget tempor risus malesuada quis. diff --git a/gitlab-pages/website/blog/2017-04-10-blog-post-two.md b/gitlab-pages/website/blog/2017-04-10-blog-post-two.md deleted file mode 100644 index 3ab4637bd..000000000 --- a/gitlab-pages/website/blog/2017-04-10-blog-post-two.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: New Blog Post -author: Blog Author -authorURL: http://twitter.com/ -authorFBID: 100002976521003 ---- - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus elementum massa eget nulla aliquet sagittis. Proin odio tortor, vulputate ut odio in, ultrices ultricies augue. Cras ornare ultrices lorem malesuada iaculis. Etiam sit amet libero tempor, pulvinar mauris sed, sollicitudin sapien. - - - -Mauris vestibulum ullamcorper nibh, ut semper purus pulvinar ut. Donec volutpat orci sit amet mauris malesuada, non pulvinar augue aliquam. Vestibulum ultricies at urna ut suscipit. Morbi iaculis, erat at imperdiet semper, ipsum nulla sodales erat, eget tincidunt justo dui quis justo. Pellentesque dictum bibendum diam at aliquet. Sed pulvinar, dolor quis finibus ornare, eros odio facilisis erat, eu rhoncus nunc dui sed ex. Nunc gravida dui massa, sed ornare arcu tincidunt sit amet. Maecenas efficitur sapien neque, a laoreet libero feugiat ut. - -Nulla facilisi. Maecenas sodales nec purus eget posuere. Sed sapien quam, pretium a risus in, porttitor dapibus erat. Sed sit amet fringilla ipsum, eget iaculis augue. Integer sollicitudin tortor quis ultricies aliquam. Suspendisse fringilla nunc in tellus cursus, at placerat tellus scelerisque. Sed tempus elit a sollicitudin rhoncus. Nulla facilisi. Morbi nec dolor dolor. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Cras et aliquet lectus. Pellentesque sit amet eros nisi. Quisque ac sapien in sapien congue accumsan. Nullam in posuere ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Proin lacinia leo a nibh fringilla pharetra. - -Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Proin venenatis lectus dui, vel ultrices ante bibendum hendrerit. Aenean egestas feugiat dui id hendrerit. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Curabitur in tellus laoreet, eleifend nunc id, viverra leo. Proin vulputate non dolor vel vulputate. Curabitur pretium lobortis felis, sit amet finibus lorem suscipit ut. Sed non mollis risus. Duis sagittis, mi in euismod tincidunt, nunc mauris vestibulum urna, at euismod est elit quis erat. Phasellus accumsan vitae neque eu placerat. In elementum arcu nec tellus imperdiet, eget maximus nulla sodales. Curabitur eu sapien eget nisl sodales fermentum. - -Phasellus pulvinar ex id commodo imperdiet. Praesent odio nibh, sollicitudin sit amet faucibus id, placerat at metus. Donec vitae eros vitae tortor hendrerit finibus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Quisque vitae purus dolor. Duis suscipit ac nulla et finibus. Phasellus ac sem sed dui dictum gravida. Phasellus eleifend vestibulum facilisis. Integer pharetra nec enim vitae mattis. Duis auctor, lectus quis condimentum bibendum, nunc dolor aliquam massa, id bibendum orci velit quis magna. Ut volutpat nulla nunc, sed interdum magna condimentum non. Sed urna metus, scelerisque vitae consectetur a, feugiat quis magna. Donec dignissim ornare nisl, eget tempor risus malesuada quis. diff --git a/gitlab-pages/website/blog/2017-09-25-testing-rss.md b/gitlab-pages/website/blog/2017-09-25-testing-rss.md deleted file mode 100644 index b7ff8129c..000000000 --- a/gitlab-pages/website/blog/2017-09-25-testing-rss.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Adding RSS Support - RSS Truncation Test -author: Eric Nakagawa -authorURL: http://twitter.com/ericnakagawa -authorFBID: 661277173 ---- -1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890 - -This should be truncated. - -This line should never render in XML. diff --git a/gitlab-pages/website/blog/2017-09-26-adding-rss.md b/gitlab-pages/website/blog/2017-09-26-adding-rss.md deleted file mode 100644 index eeb4f0477..000000000 --- a/gitlab-pages/website/blog/2017-09-26-adding-rss.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Adding RSS Support -author: Eric Nakagawa -authorURL: http://twitter.com/ericnakagawa -authorFBID: 661277173 ---- - -This is a test post. - -A whole bunch of other information. diff --git a/gitlab-pages/website/blog/2017-10-24-new-version-1.0.0.md b/gitlab-pages/website/blog/2017-10-24-new-version-1.0.0.md deleted file mode 100644 index 60761c02d..000000000 --- a/gitlab-pages/website/blog/2017-10-24-new-version-1.0.0.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: New Version 1.0.0 -author: Eric Nakagawa -authorURL: http://twitter.com/ericnakagawa -authorFBID: 661277173 ---- - -This blog post will test file name parsing issues when periods are present. diff --git a/gitlab-pages/website/blog/2019-06-07-introducing-ligo.md b/gitlab-pages/website/blog/2019-06-07-introducing-ligo.md new file mode 100644 index 000000000..db0688724 --- /dev/null +++ b/gitlab-pages/website/blog/2019-06-07-introducing-ligo.md @@ -0,0 +1,6 @@ +--- +title: Introducing LIGO +author: Matej Sima +--- + +Hello LIGO diff --git a/gitlab-pages/website/core/Footer.js b/gitlab-pages/website/core/Footer.js index 834a5dba1..c7c74a108 100644 --- a/gitlab-pages/website/core/Footer.js +++ b/gitlab-pages/website/core/Footer.js @@ -24,78 +24,45 @@ class Footer extends React.Component { render() { return (