Editing ImpVis Components - Revision history

Cclewley at 15:09, 30 September 2021

2021-09-30T15:09:15Z

← Older revision		Revision as of 15:09, 30 September 2021
Line 6:		Line 6:
	#Create a pull request from your branch to the master branch, you will need two approving reviews to get your pull request approved and merged. The reviewers should thoroughly test your components and give suggestions for improvements.		#Create a pull request from your branch to the master branch, you will need two approving reviews to get your pull request approved and merged. The reviewers should thoroughly test your components and give suggestions for improvements.
	#Now run <code>npm update @impvis/components</code> in the folders of your existing visualisations to get the latest updates.		#Now run <code>npm update @impvis/components</code> in the folders of your existing visualisations to get the latest updates.
	#Update the documentation for the [[vue components]] on the wiki to include your changes.		#Update the documentation for the [[Vue Components\|vue components]] on the wiki to include your changes.
	#<code>@impvis/components</code> library is currently on version 1.4.6		#<code>@impvis/components</code> library is currently on version 1.4.6

	[[Category:Maintaining_ImpVis]]		[[Category:Maintaining_ImpVis]]

FreyaHan at 09:43, 19 July 2021

2021-07-19T09:43:55Z

← Older revision		Revision as of 09:43, 19 July 2021
Line 7:		Line 7:
	#Now run <code>npm update @impvis/components</code> in the folders of your existing visualisations to get the latest updates.		#Now run <code>npm update @impvis/components</code> in the folders of your existing visualisations to get the latest updates.
	#Update the documentation for the [[vue components]] on the wiki to include your changes.		#Update the documentation for the [[vue components]] on the wiki to include your changes.
			#<code>@impvis/components</code> library is currently on version 1.4.6

	[[Category:Maintaining_ImpVis]]		[[Category:Maintaining_ImpVis]]

Admin at 09:11, 30 June 2021

2021-06-30T09:11:21Z

← Older revision		Revision as of 09:11, 30 June 2021
Line 6:		Line 6:
	#Create a pull request from your branch to the master branch, you will need two approving reviews to get your pull request approved and merged. The reviewers should thoroughly test your components and give suggestions for improvements.		#Create a pull request from your branch to the master branch, you will need two approving reviews to get your pull request approved and merged. The reviewers should thoroughly test your components and give suggestions for improvements.
	#Now run <code>npm update @impvis/components</code> in the folders of your existing visualisations to get the latest updates.		#Now run <code>npm update @impvis/components</code> in the folders of your existing visualisations to get the latest updates.
			#Update the documentation for the [[vue components]] on the wiki to include your changes.

	[[Category:Maintaining_ImpVis]]		[[Category:Maintaining_ImpVis]]

Admin at 10:28, 28 June 2021

2021-06-28T10:28:53Z

← Older revision		Revision as of 10:28, 28 June 2021
Line 6:		Line 6:
	#Create a pull request from your branch to the master branch, you will need two approving reviews to get your pull request approved and merged. The reviewers should thoroughly test your components and give suggestions for improvements.		#Create a pull request from your branch to the master branch, you will need two approving reviews to get your pull request approved and merged. The reviewers should thoroughly test your components and give suggestions for improvements.
	#Now run <code>npm update @impvis/components</code> in the folders of your existing visualisations to get the latest updates.		#Now run <code>npm update @impvis/components</code> in the folders of your existing visualisations to get the latest updates.

			[[Category:Maintaining_ImpVis]]

Admin at 10:28, 28 June 2021

2021-06-28T10:28:07Z

← Older revision		Revision as of 10:28, 28 June 2021
Line 5:		Line 5:
	#Iterate the version number in the package.json (line 3). For minor changes, iterate the last digit; for medium changes, the middle digit; and for very large changes iterate the first digit. E.g. a medium change would make 1.1.6 -> 1.2.6.		#Iterate the version number in the package.json (line 3). For minor changes, iterate the last digit; for medium changes, the middle digit; and for very large changes iterate the first digit. E.g. a medium change would make 1.1.6 -> 1.2.6.
	#Create a pull request from your branch to the master branch, you will need two approving reviews to get your pull request approved and merged. The reviewers should thoroughly test your components and give suggestions for improvements.		#Create a pull request from your branch to the master branch, you will need two approving reviews to get your pull request approved and merged. The reviewers should thoroughly test your components and give suggestions for improvements.
	#Now run <code>npm update @impvis/components</code> on existing visualisations to get the latest updates.		#Now run <code>npm update @impvis/components</code> in the folders of your existing visualisations to get the latest updates.

Admin at 10:27, 28 June 2021

2021-06-28T10:27:08Z

← Older revision		Revision as of 10:27, 28 June 2021
Line 5:		Line 5:
	#Iterate the version number in the package.json (line 3). For minor changes, iterate the last digit; for medium changes, the middle digit; and for very large changes iterate the first digit. E.g. a medium change would make 1.1.6 -> 1.2.6.		#Iterate the version number in the package.json (line 3). For minor changes, iterate the last digit; for medium changes, the middle digit; and for very large changes iterate the first digit. E.g. a medium change would make 1.1.6 -> 1.2.6.
	#Create a pull request from your branch to the master branch, you will need two approving reviews to get your pull request approved and merged. The reviewers should thoroughly test your components and give suggestions for improvements.		#Create a pull request from your branch to the master branch, you will need two approving reviews to get your pull request approved and merged. The reviewers should thoroughly test your components and give suggestions for improvements.
	#Now run ~~“npm~~ update @impvis/~~components”~~ on existing visualisations to get the latest updates.		#Now run <code>npm update @impvis/components</code> on existing visualisations to get the latest updates.

Admin at 10:26, 28 June 2021

2021-06-28T10:26:52Z

← Older revision		Revision as of 10:26, 28 June 2021
Line 1:		Line 1:
			If you want to make a change to one of the ImpVis components in any visualisation (referred to by <iv-component>) then you will need to follow the steps on this page.
	# To edit the components library you must first clone [https://github.com/Imperial-visualizations/Vue-Components the repository]. If you are making a small change then cloning and editing directly on the "dev" branch may work, however if you are making larger changes you may want to consider making your own fork or branch.		# To edit the components library you must first clone [https://github.com/Imperial-visualizations/Vue-Components the repository]. If you are making a small change then cloning and editing directly on the "dev" branch may work, however if you are making larger changes you may want to consider making your own fork or branch.
	# To start editing you must navigate to the folder you have cloned in a command prompt/terminal using "cd <directory path>". Once in the correct location you can run the example template to test your component by running <code>npm run template</code>. The code for this example template is located within the "template" folder.		# To start editing you must navigate to the folder you have cloned in a command prompt/terminal using "cd <directory path>". Once in the correct location you can run the example template to test your component by running <code>npm run template</code>. The code for this example template is located within the "template" folder.
			#Make your edits to the components located within the "src/components" folder, and test them using the example template.
	~~locally~~, ~~clone~~ the ~~vue components repository (you may want to create your own fork or branch).~~		#Iterate the version number in the package.json (line 3). For minor changes, iterate the last digit; for medium changes, the middle digit; and for very large changes iterate the first digit. E.g. a medium change would make 1.1.6 -> 1.2.6.
	*Run “npm run template” to get an example template ~~to view while editing vue components~~.		#Create a pull request from your branch to the master branch, you will need two approving reviews to get your pull request approved and merged. The reviewers should thoroughly test your components and give suggestions for improvements.
	* Make your changes to the ~~components~~ and ~~when ready create~~ a ~~pull request to dev and get two reviews from other people~~.		#Now run “npm update @impvis/components” on existing visualisations to get the latest updates.
	* Create pull request from ~~dev~~ to master ~~and~~ get approved. ~~(remember to increase package version in package~~.~~json)~~
	*Now run “npm update @impvis/components” on existing visualisations to get the latest updates.

Admin at 10:14, 28 June 2021

2021-06-28T10:14:05Z

← Older revision		Revision as of 10:14, 28 June 2021
Line 1:		Line 1:
	* To edit locally, clone the vue components repository (you may want to create your own fork or branch).		# To edit the components library you must first clone [https://github.com/Imperial-visualizations/Vue-Components the repository]. If you are making a small change then cloning and editing directly on the "dev" branch may work, however if you are making larger changes you may want to consider making your own fork or branch.
	* Run “npm run template” to get an example template to view while editing vue components.		# To start editing you must navigate to the folder you have cloned in a command prompt/terminal using "cd <directory path>". Once in the correct location you can run the example template to test your component by running <code>npm run template</code>. The code for this example template is located within the "template" folder.

			locally, clone the vue components repository (you may want to create your own fork or branch).
			*Run “npm run template” to get an example template to view while editing vue components.
	* Make your changes to the components and when ready create a pull request to dev and get two reviews from other people.		* Make your changes to the components and when ready create a pull request to dev and get two reviews from other people.
	* Create pull request from dev to master and get approved. (remember to increase package version in package.json)		* Create pull request from dev to master and get approved. (remember to increase package version in package.json)
	* Now run “npm update @impvis/components” on existing visualisations to get the latest updates.		*Now run “npm update @impvis/components” on existing visualisations to get the latest updates.

Admin at 10:08, 28 June 2021

2021-06-28T10:08:09Z

← Older revision		Revision as of 10:08, 28 June 2021
Line 1:		Line 1:
	To edit locally, clone the vue components repository (you may want to create your own fork or branch).		* To edit locally, clone the vue components repository (you may want to create your own fork or branch).
	Run “npm run template” to get an example template to view while editing vue components.		* Run “npm run template” to get an example template to view while editing vue components.
	Make your changes to the components and when ready create a pull request to dev and get two reviews from other people.		* Make your changes to the components and when ready create a pull request to dev and get two reviews from other people.
	Create pull request from dev to master and get approved. (remember to increase package version in package.json)		* Create pull request from dev to master and get approved. (remember to increase package version in package.json)
	Now run “npm update @impvis/components” on existing visualisations to get the latest updates.		* Now run “npm update @impvis/components” on existing visualisations to get the latest updates.

Admin: Created page with "To edit locally, clone the vue components repository (you may want to create your own fork or branch). Run “npm run template” to get an example template to view while edit..."

2021-06-28T10:07:55Z

Created page with "To edit locally, clone the vue components repository (you may want to create your own fork or branch). Run “npm run template” to get an example template to view while edit..."

New page

To edit locally, clone the vue components repository (you may want to create your own fork or branch).
Run “npm run template” to get an example template to view while editing vue components.
Make your changes to the components and when ready create a pull request to dev and get two reviews from other people.
Create pull request from dev to master and get approved. (remember to increase package version in package.json)
Now run “npm update @impvis/components” on existing visualisations to get the latest updates.