Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split the documentation into branches #99

Closed
5 of 6 tasks
laurentj opened this issue Aug 30, 2018 · 3 comments
Closed
5 of 6 tasks

Split the documentation into branches #99

laurentj opened this issue Aug 30, 2018 · 3 comments
Assignees

Comments

@laurentj
Copy link
Collaborator

laurentj commented Aug 30, 2018

The actual documentation contains instructions for several version of Lizmap. It become less and less readable.

I propose to have one branch for each version of Lizmap, and so each branch talk about only one version at a time.

Because of the release of 3.2 which is too soon, I don't think we should create a branch which contains only 3.2 stuffs.

So here are some ideas:

  • let's create a 3.2 branch, which contains the current documentation about lizmap 3.0, 3.1, 3.2 and event old 2.x stuffs..
  • then on the master, the documentation will talk about only about the next version, so we will remove old stuffs about 3.0, 3.1, 2.x, and progressively, stuffs specific to 3.2
  • when the next version will be released, we will create a new branch.

This new organization means changes in:

  • localization, and so configuration into Transifex
  • configuration of the web server, in order to have docs.lizmap.com/3.2, docs.lizmap.com/3.3 etc
  • an alias docs.lizmap.com/current to the documentation of the latest release.
  • configuration of continous integration on our platform.
  • redirection from docs.3liz.com to docs.lizmap.com/current/
  • a version selector at the top of each page
  • And why not a docs.lizmap.com/master for the documentation for the master branch.
@laurentj laurentj self-assigned this Aug 30, 2018
@laurentj
Copy link
Collaborator Author

At the moment, we have two branch: master and release. Master is deployed on our test server, and release is deployed on the production server.

I don't think we should have a test branch for each version, as each branch for version are about stable versions. So, here are the future branches (let's imagine that 4.0 is the latest version of Lizmap):

branch lizmap version url
master future version test server (internal)
release future version docs.lizmap.com/next
release_4_0 4.0 docs.lizmap.com/4.0/ and docs.lizmap.com/current/
release_3_3 3.3 docs.lizmap.com/3.3/
release_3_2 3.2, 3.1, 3.0, 2.x docs.lizmap.com/3.2/

@laurentj laurentj changed the title Split the documentation into branch Split the documentation into branches Aug 30, 2018
laurentj added a commit that referenced this issue Sep 6, 2018
@laurentj
Copy link
Collaborator Author

laurentj commented Sep 6, 2018

The server is almost configured : TLS certificate has to be generated and we're waiting after update of DNS informations about the new domain name.

our new .gitlab-ci is working. The "release" branch will be deleted soon.

Because many thing in the installation are too deprecated, we could not keep that informations for lizmap 3.2, but we could keep them for old release. So I created a new branch lizmap_3_1 which will be dedicated to Lizmap 3.1 and older version, and we can now update master for lizmap 3.2 and do some cleanup.

The Transiflex ressources should be created for the lizmap_3_1 branch.

laurentj added a commit that referenced this issue Sep 7, 2018
laurentj added a commit that referenced this issue Sep 7, 2018
- .pot files are now published at each commit
- .po files are updated from Tx when publishing on the web site
  (but there are not commited into the repository)

Refs #99
laurentj added a commit that referenced this issue Sep 7, 2018
- .pot files are now published at each commit
- .po files are updated from Tx when publishing on the web site
  (but there are not commited into the repository)

Refs #99
laurentj added a commit that referenced this issue Sep 10, 2018
laurentj added a commit that referenced this issue Sep 10, 2018
@laurentj
Copy link
Collaborator Author

https://docs.lizmap.com is ready ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant